chore(docs): clean up unit test directory and jest config (#4357)

aws-amplify · Aug 17, 2023 · b87a639 · b87a639
1 parent 7680f58
commit b87a639
Show file tree

Hide file tree

Showing 12 changed files with 16 additions and 10 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -27,10 +27,19 @@ Note, if you're not using `nvm`, you'll need to set the environment variable: `e
 
 ### Test
 
-- Run `yarn test` to test.
-- If the snapshot test fails, run `yarn test -- -u`.
+From the monorepo root run:
 
-Test runs after build.
+```sh
+$ yarn docs test
+```
+
+#### Updating Props Table Snapshot
+
+To update the Props Table snapshot run:
+
+```sh
+$ yarn docs test -u __tests__/props-table.test.ts
+```
 
 ### Creating a Page
 

diff --git a/.../__snapshots__/cssvars-table.test.ts.snap → .../__snapshots__/cssvars-table.test.ts.snap b/.../__snapshots__/cssvars-table.test.ts.snap → .../__snapshots__/cssvars-table.test.ts.snap
diff --git a/...ts/__snapshots__/props-table.test.ts.snap → ...__/__snapshots__/props-table.test.ts.snap b/...ts/__snapshots__/props-table.test.ts.snap → ...__/__snapshots__/props-table.test.ts.snap
diff --git a/.../tests/__snapshots__/sitemap.test.ts.snap → ...ests__/__snapshots__/sitemap.test.ts.snap b/.../tests/__snapshots__/sitemap.test.ts.snap → ...ests__/__snapshots__/sitemap.test.ts.snap
diff --git a/docs/tests/cssvars-table.test.ts → docs/__tests__/cssvars-table.test.ts b/docs/tests/cssvars-table.test.ts → docs/__tests__/cssvars-table.test.ts
diff --git a/docs/tests/props-table.test.ts → docs/__tests__/props-table.test.ts b/docs/tests/props-table.test.ts → docs/__tests__/props-table.test.ts
diff --git a/docs/tests/sitemap.test.ts → docs/__tests__/sitemap.test.ts b/docs/tests/sitemap.test.ts → docs/__tests__/sitemap.test.ts
diff --git a/docs/tests/tsconfig.json → docs/__tests__/tsconfig.json b/docs/tests/tsconfig.json → docs/__tests__/tsconfig.json
diff --git a/docs/jest.config.ts b/docs/jest.config.ts
@@ -3,14 +3,13 @@
  * https://jestjs.io/docs/configuration
  */
 
-export default {
-  collectCoverage: true,
-  coverageDirectory: 'coverage',
-  coverageProvider: 'v8',
+const jestConfig = {
   preset: 'ts-jest',
   setupFiles: ['./jestEnv.ts'],
   transform: {
     '^.+\\.(ts|tsx)?$': 'ts-jest',
     '^.+\\.(js|jsx)$': 'babel-jest',
   },
 };
+
+export default jestConfig;
diff --git a/docs/package.json b/docs/package.json
@@ -64,7 +64,6 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@babel/preset-env": "^7.20.2",
     "@supercharge/promise-pool": "^2.4.0",
     "@types/jest": "^27",
     "@types/lodash": "^4.14.170",

diff --git a/docs/tests/babel.config.js b/docs/tests/babel.config.js
diff --git a/yarn.lock b/yarn.lock