Merge pull request #117 from apache/esm-tests

Author: tilgovi

.eslintrc.js

@@ -25,7 +25,7 @@ module.exports = {
   extends: ['eslint:recommended', 'plugin:import/recommended', 'prettier'],
   plugins: ['import', 'prettier'],
   rules: {
-    'import/extensions': ['error', 'never'],
+    'import/extensions': ['error', 'ignorePackages'],
     'import/first': 'error',
     'import/newline-after-import': 'error',
     'import/no-absolute-path': 'error',

.gitignore

@@ -1,7 +1,6 @@
 *.d.ts
 !/packages/**/src/**/*.d.ts
 *.d.ts.map
-.nyc_output
 coverage
 docs
 node_modules

.mocharc.js

@@ -23,7 +23,8 @@
 module.exports = {
   extension: ['.ts'],
   ignore: ['node_modules'],
-  require: ['./babel-register.js', 'global-jsdom/register'],
+  loader: 'babel-register-esm',
+  require: ['global-jsdom/register'],
   timeout: 5000,
   watchFiles: [
     './test/**/*.ts',

babel-register.js

@@ -21,7 +21,9 @@
  */
 
 const path = require('path');
-const { DEFAULT_EXTENSIONS } = require('@babel/core');
+const { resolvePath } = require('babel-plugin-module-resolver');
+
+const packagePath = path.join(__dirname, 'packages');
 
 module.exports = (api) => {
   const ENV = api.env();
@@ -33,8 +35,8 @@ module.exports = (api) => {
     // Use minimal syntax fixes where possible
     // Note: This setting may become the default in Babel 8.
     bugfixes: true,
-    // Transform module syntax if necessary.
-    modules: TEST ? 'commonjs' : false,
+    // Do not transform module syntax.
+    modules: false,
   };
 
   // Options for the @babel/typescript preset.
@@ -45,37 +47,40 @@ module.exports = (api) => {
     onlyRemoveTypeImports: true,
   };
 
-  const addImportExtensionOptions = {
-    extension: DEV || TEST ? 'ts' : 'js',
-  };
-
   // Options for the module-resolver plugin.
   // Used for resolving source files during development.
   const resolverOptions = {
-    alias: {
-      ...(DEV || TEST
-        ? {
+    ...(DEV || TEST
+      ? {
+          alias: {
             '^@apache-annotator/([^/]+)$': ([, name]) =>
-              path.join(__dirname, 'packages', name, '/src/index.ts'),
-          }
-        : null),
-    },
-    extensions: ['.ts', '.tsx', ...DEFAULT_EXTENSIONS],
+              path.join(packagePath, name, 'src', 'index.ts'),
+          },
+          resolvePath(sourcePath, currentFile, opts) {
+            if (
+              currentFile.startsWith(packagePath) &&
+              currentFile.endsWith('.ts') &&
+              sourcePath.startsWith('.') &&
+              sourcePath.endsWith('.js')
+            ) {
+              return sourcePath.replace(/\.js$/, '.ts');
+            }
+            return resolvePath(sourcePath, currentFile, opts);
+          },
+        }
+      : null),
   };
 
   // Options for the @babel/transform-runtime plugin.
   const runtimeOptions = {
     // Use corejs version 3.
     corejs: { version: 3, proposals: true },
-    // Use helpers formatted for the target environment.
-    useESModules: !TEST,
   };
 
   return {
     plugins: [
       '@babel/plugin-proposal-class-properties',
       ['@babel/transform-runtime', runtimeOptions],
-      ['add-import-extension', addImportExtensionOptions],
       ['module-resolver', resolverOptions],
       'preserve-comment-header',
       ...(TEST ? ['istanbul'] : []),

babel.config.js

@@ -19,14 +19,15 @@
     "build:js": "lerna exec --parallel -- babel -d lib -s -x .ts --env-name production --root-mode upward src",
     "build:misc": "lerna exec --parallel -- cp ../../DISCLAIMER-WIP ../../LICENSE ../../NOTICE ../../README.md .",
     "build:types": "tsc --build",
-    "clean": "tsc --build --clean && lerna exec -- rimraf DISCLAIMER-WIP LICENSE NOTICE README.md lib && rimraf .nyc_output coverage docs web/dist *.tsbuildinfo",
+    "clean": "tsc --build --clean && lerna exec -- rimraf DISCLAIMER-WIP LICENSE NOTICE README.md coverage docs lib web/dist",
     "docs": "tsc --build && typedoc",
     "lint": "eslint .",
     "prepublishOnly": "yarn run build",
     "publish": "lerna publish",
     "publish:ci": "yarn run publish --canary --exact --force-publish '*' --no-verify-access --yes minor",
     "start": "yarn run web:server",
-    "test": "cross-env BABEL_ENV=test nyc mocha packages/**/*.test.ts",
+    "test": "cross-env BABEL_ENV=test c8 -a -r html -r text mocha packages/**/*.test.ts",
+    "test:watch": "cross-env BABEL_ENV=test mocha -p -w packages/**/*.test.ts",
     "validate": "cross-env BABEL_ENV=test mocha test/**/*.test.ts",
     "web:build": "webpack --config=web/webpack.config.js --mode development",
     "web:server": "webpack-dev-server --config=web/webpack.config.js --hot --mode development"
@@ -38,20 +39,18 @@
     "@babel/plugin-transform-runtime": "^7.13.10",
     "@babel/preset-env": "^7.13.12",
     "@babel/preset-typescript": "^7.13.0",
-    "@babel/register": "^7.13.14",
-    "@types/chai": "^4.2.11",
-    "@types/mocha": "^7.0.2",
+    "@types/mocha": "^9.0.0",
     "@types/node-fetch": "^2.5.7",
     "@types/resolve": "^1.17.0",
     "@typescript-eslint/eslint-plugin": "^4.20.0",
     "@typescript-eslint/parser": "^4.20.0",
     "ajv": "^6.11.0",
     "babel-loader": "^8.0.5",
-    "babel-plugin-add-import-extension": "^1.4.1",
     "babel-plugin-istanbul": "^6.0.0",
     "babel-plugin-module-resolver": "^4.0.0",
     "babel-plugin-preserve-comment-header": "^1.0.1",
-    "chai": "^4.2.0",
+    "babel-register-esm": "^1.2.1",
+    "c8": "^7.10.0",
     "concurrently": "^5.3.0",
     "cross-env": "^6.0.3",
     "eslint": "^7.5.0",
@@ -66,9 +65,8 @@
     "jsdom": "^16.2.2",
     "lerna": "^3.20.2",
     "lint-staged": "^10.0.2",
-    "mocha": "^8.0.1",
+    "mocha": "^9.1.3",
     "node-fetch": "^2.5.0",
-    "nyc": "^15.0.0",
     "prettier": "^2.0.5",
     "resolve": "^1.15.0",
     "rimraf": "^3.0.0",
@@ -80,7 +78,7 @@
     "webpack-dev-server": "^3.10.1"
   },
   "engines": {
-    "node": "^12.20 || ^14.15 || ^15.4 || ^16.0",
+    "node": "^12.20 || ^14.15 || ^15.4 || ^16.0 || ^17.0",
     "yarn": "^1.5.0"
   }
 }

nyc.config.js

@@ -20,7 +20,7 @@
     "@babel/runtime-corejs3": "^7.13.10"
   },
   "engines": {
-    "node": "^12.20 || ^14.15 || ^15.4 || ^16.0"
+    "node": "^12.20 || ^14.15 || ^15.4 || ^16.0 || ^17.0"
   },
   "publishConfig": {
     "access": "public"

package.json

@@ -16,10 +16,10 @@
   "dependencies": {
     "@apache-annotator/selector": "^0.2.0",
     "@babel/runtime-corejs3": "^7.13.10",
-    "optimal-select": "^4.0.1"
+    "@medv/finder": "^2.1.0"
   },
   "engines": {
-    "node": "^12.20 || ^14.15 || ^15.4 || ^16.0"
+    "node": "^12.20 || ^14.15 || ^15.4 || ^16.0 || ^17.0"
   },
   "publishConfig": {
     "access": "public"

packages/apache-annotator/package.json

@@ -20,10 +20,10 @@
  * under the License.
  */
 
-import optimalSelect from 'optimal-select';
+import { finder } from '@medv/finder';
 import type { CssSelector, Matcher } from '@apache-annotator/selector';
-import { ownerDocument } from './owner-document';
-import { toRange } from './to-range';
+import { ownerDocument } from './owner-document.js';
+import { toRange } from './to-range.js';
 
 /**
  * Find the elements corresponding to the given {@link
@@ -112,9 +112,9 @@ export function createCssSelectorMatcher(
  */
 export async function describeCss(
   element: HTMLElement,
-  scope: Node = element.ownerDocument,
+  scope: Element = element.ownerDocument.documentElement,
 ): Promise<CssSelector> {
-  const selector = optimalSelect(element, { root: scope });
+  const selector = finder(element, { root: scope });
   return {
     type: 'CssSelector',
     value: selector,

packages/dom/package.json

@@ -20,8 +20,8 @@
  * under the License.
  */
 
-import { ownerDocument } from './owner-document';
-import { toRange } from './to-range';
+import { ownerDocument } from './owner-document.js';
+import { toRange } from './to-range.js';
 
 /**
  * Wrap each text node in a given Node or Range with a `<mark>` or other

packages/dom/src/css.ts

@@ -20,8 +20,8 @@
  * under the License.
  */
 
-export * from './css';
-export * from './range';
-export * from './text-quote';
-export * from './text-position';
-export * from './highlight-text';
+export * from './css.js';
+export * from './range/index.js';
+export * from './text-quote/index.js';
+export * from './text-position/index.js';
+export * from './highlight-text.js';

packages/dom/src/highlight-text.ts

@@ -20,7 +20,7 @@
  * under the License.
  */
 
-import { ownerDocument } from './owner-document';
+import { ownerDocument } from './owner-document.js';
 
 /**
  * TextRange is a Range that guarantees to always have Text nodes as its start

packages/dom/src/index.ts

@@ -20,4 +20,4 @@
  * under the License.
  */
 
-export * from './match';
+export * from './match.js';

packages/dom/src/normalize-range.ts

@@ -25,9 +25,9 @@ import type {
   RangeSelector,
   Selector,
 } from '@apache-annotator/selector';
-import { ownerDocument } from '../owner-document';
-import { toRange } from '../to-range';
-import { cartesian } from './cartesian';
+import { ownerDocument } from '../owner-document.js';
+import { toRange } from '../to-range.js';
+import { cartesian } from './cartesian.js';
 
 /**
  * Find the range(s) corresponding to the given {@link RangeSelector}.

packages/dom/src/optimal-select.d.ts

@@ -21,9 +21,9 @@
  */
 
 import type { Chunk, Chunker, ChunkRange } from '@apache-annotator/selector';
-import { normalizeRange } from './normalize-range';
-import { ownerDocument } from './owner-document';
-import { toRange } from './to-range';
+import { normalizeRange } from './normalize-range.js';
+import { ownerDocument } from './owner-document.js';
+import { toRange } from './to-range.js';
 
 export interface PartialTextNode extends Chunk<string> {
   readonly node: Text;

packages/dom/src/range/index.ts

@@ -22,9 +22,9 @@
 
 import type { TextPositionSelector } from '@apache-annotator/selector';
 import { describeTextPosition as abstractDescribeTextPosition } from '@apache-annotator/selector';
-import { ownerDocument } from '../owner-document';
-import { TextNodeChunker } from '../text-node-chunker';
-import { toRange } from '../to-range';
+import { ownerDocument } from '../owner-document.js';
+import { TextNodeChunker } from '../text-node-chunker.js';
+import { toRange } from '../to-range.js';
 
 /**
  * Returns a {@link TextPositionSelector} that points at the target text within

packages/dom/src/range/match.ts

@@ -20,5 +20,5 @@
  * under the License.
  */
 
-export * from './describe';
-export * from './match';
+export * from './describe.js';
+export * from './match.js';

packages/dom/src/text-node-chunker.ts

@@ -22,7 +22,7 @@
 
 import type { Matcher, TextPositionSelector } from '@apache-annotator/selector';
 import { textPositionSelectorMatcher as abstractTextPositionSelectorMatcher } from '@apache-annotator/selector';
-import { TextNodeChunker } from '../text-node-chunker';
+import { TextNodeChunker } from '../text-node-chunker.js';
 
 /**
  * Find the range of text corresponding to the given {@link