@openedx/frontend-base 2.0.0-alpha.5 → 2.0.0-alpha.7

package/README.md

@@ -28,6 +28,8 @@ Once the change matures, we recommend moving over to the pre-configured [npm wor
 
 To do so, check this repository out into the site's `packages/` directory.  Then, run `npm run dev:packages` from the site's root directory: this will watch-build any workspace check-outs and start the dev server, picking up changes automatically.  If any apps (such as `frontend-app-instructor-dashboard`) require corresponding changes, you can check them out into the `packages/` directory as siblings to `frontend-base`. See [Local development with workspaces](https://github.com/openedx/frontend-template-site#local-development-with-workspaces) for full setup details.
 
+Checkouts in `packages/` are excluded from an app's Jest crawl, so running the app's test suite there behaves the same as it does against a published `frontend-base`.
+
 ### Continuous integration
 
 In addition to running lint and the test suite, Github CI builds the included `test-site` against a packed tarball of `frontend-base`.  This verifies that the library still works end-to-end as a real dependency of a consuming site.

package/dist/runtime/jest.config.js

@@ -4,8 +4,8 @@ module.exports = {
         '<rootDir>/setupTest.js',
     ],
     moduleNameMapper: {
-        '\\.svg$': '<rootDir>/__mocks__/svg.js',
-        '\\.(jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': '<rootDir/__mocks__/file.js',
+        '\\.svg$': '<rootDir>/testMocks/svg.js',
+        '\\.(jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': '<rootDir>/testMocks/file.js',
         '\\.(css|scss)$': require.resolve('identity-obj-proxy'),
         'site.config': '<rootDir>/site.config.test.tsx',
     },

package/dist/runtime/jest.config.js.map

@@ -1 +1 @@
-{"version":3,"file":"jest.config.js","sourceRoot":"","sources":["../../runtime/jest.config.js"],"names":[],"mappings":";AAAA,MAAM,CAAC,OAAO,GAAG;IACf,kBAAkB,EAAE;QAClB,wBAAwB;KACzB;IACD,gBAAgB,EAAE;QAChB,SAAS,EAAE,4BAA4B;QACvC,iFAAiF,EAAE,4BAA4B;QAC/G,gBAAgB,EAAE,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC;QACvD,aAAa,EAAE,gCAAgC;KAChD;IACD,eAAe,EAAE,OAAO;IACxB,sBAAsB,EAAE;QACtB,GAAG,EAAE,mBAAmB;KACzB;IACD,mBAAmB,EAAE;QACnB,gCAAgC;KACjC;IACD,0BAA0B,EAAE;QAC1B,wBAAwB;KACzB;IACD,uBAAuB,EAAE;QACvB,4EAA4E;KAC7E;IACD,wBAAwB,EAAE;QACxB,QAAQ;KACT;IACD,sBAAsB,EAAE;QACtB,uBAAuB;QACvB,gBAAgB;QAChB,QAAQ;KACT;CACF,CAAC","sourcesContent":["module.exports = {\n  setupFilesAfterEnv: [\n    '<rootDir>/setupTest.js',\n  ],\n  moduleNameMapper: {\n    '\\\\.svg$': '<rootDir>/__mocks__/svg.js',\n    '\\\\.(jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': '<rootDir/__mocks__/file.js',\n    '\\\\.(css|scss)$': require.resolve('identity-obj-proxy'),\n    'site.config': '<rootDir>/site.config.test.tsx',\n  },\n  testEnvironment: 'jsdom',\n  testEnvironmentOptions: {\n    url: 'http://localhost/',\n  },\n  collectCoverageFrom: [\n    '<rootDir>/**/*.{js,jsx,ts,tsx}',\n  ],\n  coveragePathIgnorePatterns: [\n    '<rootDir>/setupTest.js',\n  ],\n  transformIgnorePatterns: [\n    '/node_modules/(?!(@openedx|@edx|react-intl|@formatjs|intl-messageformat)/)',\n  ],\n  modulePathIgnorePatterns: [\n    '/dist/',\n  ],\n  testPathIgnorePatterns: [\n    '/site.config.test.tsx',\n    '/node_modules/',\n    '/dist/',\n  ],\n};\n"]}
+{"version":3,"file":"jest.config.js","sourceRoot":"","sources":["../../runtime/jest.config.js"],"names":[],"mappings":";AAAA,MAAM,CAAC,OAAO,GAAG;IACf,kBAAkB,EAAE;QAClB,wBAAwB;KACzB;IACD,gBAAgB,EAAE;QAChB,SAAS,EAAE,4BAA4B;QACvC,iFAAiF,EAAE,6BAA6B;QAChH,gBAAgB,EAAE,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC;QACvD,aAAa,EAAE,gCAAgC;KAChD;IACD,eAAe,EAAE,OAAO;IACxB,sBAAsB,EAAE;QACtB,GAAG,EAAE,mBAAmB;KACzB;IACD,mBAAmB,EAAE;QACnB,gCAAgC;KACjC;IACD,0BAA0B,EAAE;QAC1B,wBAAwB;KACzB;IACD,uBAAuB,EAAE;QACvB,4EAA4E;KAC7E;IACD,wBAAwB,EAAE;QACxB,QAAQ;KACT;IACD,sBAAsB,EAAE;QACtB,uBAAuB;QACvB,gBAAgB;QAChB,QAAQ;KACT;CACF,CAAC","sourcesContent":["module.exports = {\n  setupFilesAfterEnv: [\n    '<rootDir>/setupTest.js',\n  ],\n  moduleNameMapper: {\n    '\\\\.svg$': '<rootDir>/testMocks/svg.js',\n    '\\\\.(jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': '<rootDir>/testMocks/file.js',\n    '\\\\.(css|scss)$': require.resolve('identity-obj-proxy'),\n    'site.config': '<rootDir>/site.config.test.tsx',\n  },\n  testEnvironment: 'jsdom',\n  testEnvironmentOptions: {\n    url: 'http://localhost/',\n  },\n  collectCoverageFrom: [\n    '<rootDir>/**/*.{js,jsx,ts,tsx}',\n  ],\n  coveragePathIgnorePatterns: [\n    '<rootDir>/setupTest.js',\n  ],\n  transformIgnorePatterns: [\n    '/node_modules/(?!(@openedx|@edx|react-intl|@formatjs|intl-messageformat)/)',\n  ],\n  modulePathIgnorePatterns: [\n    '/dist/',\n  ],\n  testPathIgnorePatterns: [\n    '/site.config.test.tsx',\n    '/node_modules/',\n    '/dist/',\n  ],\n};\n"]}

package/dist/shell/jest.config.js

@@ -4,8 +4,8 @@ module.exports = {
         './setupTest.js',
     ],
     moduleNameMapper: {
-        '\\.svg$': '<rootDir>/__mocks__/svg.js',
-        '\\.(jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': '<rootDir>/__mocks__/file.js',
+        '\\.svg$': '<rootDir>/testMocks/svg.js',
+        '\\.(jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': '<rootDir>/testMocks/file.js',
         '\\.(css|scss)$': require.resolve('identity-obj-proxy'),
         'site.config': '<rootDir>/site.config.test.tsx',
     },

package/dist/shell/jest.config.js.map

@@ -1 +1 @@
-{"version":3,"file":"jest.config.js","sourceRoot":"","sources":["../../shell/jest.config.js"],"names":[],"mappings":";AAAA,MAAM,CAAC,OAAO,GAAG;IACf,kBAAkB,EAAE;QAClB,gBAAgB;KACjB;IACD,gBAAgB,EAAE;QAChB,SAAS,EAAE,4BAA4B;QACvC,iFAAiF,EAAE,6BAA6B;QAChH,gBAAgB,EAAE,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC;QACvD,aAAa,EAAE,gCAAgC;KAChD;IACD,eAAe,EAAE,OAAO;IACxB,sBAAsB,EAAE;QACtB,GAAG,EAAE,mBAAmB;KACzB;IACD,mBAAmB,EAAE;QACnB,gCAAgC;KACjC;IACD,0BAA0B,EAAE;QAC1B,gBAAgB;QAChB,cAAc;KACf;IACD,uBAAuB,EAAE;QACvB,4EAA4E;KAC7E;IACD,sBAAsB,EAAE;QACtB,uBAAuB;QACvB,gBAAgB;QAChB,QAAQ;KACT;CACF,CAAC","sourcesContent":["module.exports = {\n  setupFilesAfterEnv: [\n    './setupTest.js',\n  ],\n  moduleNameMapper: {\n    '\\\\.svg$': '<rootDir>/__mocks__/svg.js',\n    '\\\\.(jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': '<rootDir>/__mocks__/file.js',\n    '\\\\.(css|scss)$': require.resolve('identity-obj-proxy'),\n    'site.config': '<rootDir>/site.config.test.tsx',\n  },\n  testEnvironment: 'jsdom',\n  testEnvironmentOptions: {\n    url: 'http://localhost/',\n  },\n  collectCoverageFrom: [\n    '<rootDir>/**/*.{js,jsx,ts,tsx}',\n  ],\n  coveragePathIgnorePatterns: [\n    '/node_modules/',\n    'setupTest.js',\n  ],\n  transformIgnorePatterns: [\n    '/node_modules/(?!(@openedx|@edx|react-intl|@formatjs|intl-messageformat)/)',\n  ],\n  testPathIgnorePatterns: [\n    '/site.config.test.tsx',\n    '/node_modules/',\n    '/dist/',\n  ],\n};\n"]}
+{"version":3,"file":"jest.config.js","sourceRoot":"","sources":["../../shell/jest.config.js"],"names":[],"mappings":";AAAA,MAAM,CAAC,OAAO,GAAG;IACf,kBAAkB,EAAE;QAClB,gBAAgB;KACjB;IACD,gBAAgB,EAAE;QAChB,SAAS,EAAE,4BAA4B;QACvC,iFAAiF,EAAE,6BAA6B;QAChH,gBAAgB,EAAE,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC;QACvD,aAAa,EAAE,gCAAgC;KAChD;IACD,eAAe,EAAE,OAAO;IACxB,sBAAsB,EAAE;QACtB,GAAG,EAAE,mBAAmB;KACzB;IACD,mBAAmB,EAAE;QACnB,gCAAgC;KACjC;IACD,0BAA0B,EAAE;QAC1B,gBAAgB;QAChB,cAAc;KACf;IACD,uBAAuB,EAAE;QACvB,4EAA4E;KAC7E;IACD,sBAAsB,EAAE;QACtB,uBAAuB;QACvB,gBAAgB;QAChB,QAAQ;KACT;CACF,CAAC","sourcesContent":["module.exports = {\n  setupFilesAfterEnv: [\n    './setupTest.js',\n  ],\n  moduleNameMapper: {\n    '\\\\.svg$': '<rootDir>/testMocks/svg.js',\n    '\\\\.(jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': '<rootDir>/testMocks/file.js',\n    '\\\\.(css|scss)$': require.resolve('identity-obj-proxy'),\n    'site.config': '<rootDir>/site.config.test.tsx',\n  },\n  testEnvironment: 'jsdom',\n  testEnvironmentOptions: {\n    url: 'http://localhost/',\n  },\n  collectCoverageFrom: [\n    '<rootDir>/**/*.{js,jsx,ts,tsx}',\n  ],\n  coveragePathIgnorePatterns: [\n    '/node_modules/',\n    'setupTest.js',\n  ],\n  transformIgnorePatterns: [\n    '/node_modules/(?!(@openedx|@edx|react-intl|@formatjs|intl-messageformat)/)',\n  ],\n  testPathIgnorePatterns: [\n    '/site.config.test.tsx',\n    '/node_modules/',\n    '/dist/',\n  ],\n};\n"]}

package/dist/tools/eslint/base.eslint.config.js

@@ -16,6 +16,7 @@ module.exports = tseslint.config(eslint.configs.recommended, ...tseslint.configs
         'dist/*',
         'node_modules/*',
         '**/__mocks__/*',
+        '**/testMocks/*',
         '**/__snapshots__/*',
     ],
 }, {

package/dist/tools/jest/jest.config.js

@@ -19,12 +19,20 @@ module.exports = {
     transformIgnorePatterns: [
         '/node_modules/(?!(@openedx|@edx|react-intl|@formatjs|intl-messageformat)/)',
     ],
+    /*
+     * 'packages/' holds gitignored, bind-mounted checkouts used for local
+     * development.  Excluding it here keeps jest-haste-map from crawling those
+     * checkouts, which would otherwise register their manual mocks and collect
+     * their test suites as if they belonged to this app.
+     */
     modulePathIgnorePatterns: [
         '/dist/',
+        '<rootDir>/packages/',
     ],
     testPathIgnorePatterns: [
         '/site.config.test.tsx',
         '/node_modules/',
         '/dist/',
+        '<rootDir>/packages/',
     ],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openedx/frontend-base",
-  "version": "2.0.0-alpha.5",
+  "version": "2.0.0-alpha.7",
   "description": "Build tools, setup and config for frontend apps",
   "publishConfig": {
     "access": "public"
@@ -30,8 +30,8 @@
     "clean": "make clean",
     "dev": "npm run build && node ./dist/tools/cli/openedx.js dev:shell",
     "docs": "jsdoc -c jsdoc.json",
-    "lint": "eslint .; npm run lint:tools; npm --prefix ./test-site run lint",
-    "lint:fix": "eslint . --fix; npm run lint:fix:tools",
+    "lint": "eslint . && npm run lint:tools && npm --prefix ./test-site run lint",
+    "lint:fix": "eslint . --fix && npm run lint:fix:tools",
     "lint:tools": "cd ./tools && eslint . && cd ..",
     "lint:fix:tools": "cd ./tools && eslint . --fix && cd ..",
     "pack": "mkdir -p pack && npm pack --silent --pack-destination pack >/dev/null && mv \"$(ls -t pack/*.tgz | head -n 1)\" pack/openedx-frontend-base.tgz",