refactor: use file extensions (as per ESM) (#1135)

src/bin/generateRule.js

@@ -54,7 +54,7 @@ const recommended = options.includes('--recommended');
   await fs.writeFile(ruleNamesPath, JSON.stringify(ruleNames, null, 2) + '\n');
   console.log('ruleNames', ruleNames);
 
-  const ruleTemplate = `import iterateJsdoc from '../iterateJsdoc';
+  const ruleTemplate = `import iterateJsdoc from '../iterateJsdoc.js';
 
 export default iterateJsdoc(({
   context,
@@ -249,9 +249,9 @@ export default iterateJsdoc(({
 
   await replaceInOrder({
     checkName: 'index import',
-    newLine: `import ${camelCasedRuleName} from './rules/${camelCasedRuleName}';`,
+    newLine: `import ${camelCasedRuleName} from './rules/${camelCasedRuleName}.js';`,
     oldIsCamel: true,
-    oldRegex: /\nimport (?<oldRule>[^ ]*) from '.\/rules\/\1';/gu,
+    oldRegex: /\nimport (?<oldRule>[^ ]*) from '.\/rules\/\1\.js';/gu,
     path: './src/index.js',
   });
 

src/index.js

@@ -1,59 +1,61 @@
-import checkAccess from './rules/checkAccess';
-import checkAlignment from './rules/checkAlignment';
-import checkExamples from './rules/checkExamples';
-import checkIndentation from './rules/checkIndentation';
-import checkLineAlignment from './rules/checkLineAlignment';
-import checkParamNames from './rules/checkParamNames';
-import checkPropertyNames from './rules/checkPropertyNames';
-import checkSyntax from './rules/checkSyntax';
-import checkTagNames from './rules/checkTagNames';
-import checkTypes from './rules/checkTypes';
-import checkValues from './rules/checkValues';
-import emptyTags from './rules/emptyTags';
-import implementsOnClasses from './rules/implementsOnClasses';
-import importsAsDependencies from './rules/importsAsDependencies';
-import informativeDocs from './rules/informativeDocs';
-import matchDescription from './rules/matchDescription';
-import matchName from './rules/matchName';
-import multilineBlocks from './rules/multilineBlocks';
-import noBadBlocks from './rules/noBadBlocks';
-import noBlankBlockDescriptions from './rules/noBlankBlockDescriptions';
-import noBlankBlocks from './rules/noBlankBlocks';
-import noDefaults from './rules/noDefaults';
-import noMissingSyntax from './rules/noMissingSyntax';
-import noMultiAsterisks from './rules/noMultiAsterisks';
-import noRestrictedSyntax from './rules/noRestrictedSyntax';
-import noTypes from './rules/noTypes';
-import noUndefinedTypes from './rules/noUndefinedTypes';
-import requireAsteriskPrefix from './rules/requireAsteriskPrefix';
-import requireDescription from './rules/requireDescription';
-import requireDescriptionCompleteSentence from './rules/requireDescriptionCompleteSentence';
-import requireExample from './rules/requireExample';
-import requireFileOverview from './rules/requireFileOverview';
-import requireHyphenBeforeParamDescription from './rules/requireHyphenBeforeParamDescription';
-import requireJsdoc from './rules/requireJsdoc';
-import requireParam from './rules/requireParam';
-import requireParamDescription from './rules/requireParamDescription';
-import requireParamName from './rules/requireParamName';
-import requireParamType from './rules/requireParamType';
-import requireProperty from './rules/requireProperty';
-import requirePropertyDescription from './rules/requirePropertyDescription';
-import requirePropertyName from './rules/requirePropertyName';
-import requirePropertyType from './rules/requirePropertyType';
-import requireReturns from './rules/requireReturns';
-import requireReturnsCheck from './rules/requireReturnsCheck';
-import requireReturnsDescription from './rules/requireReturnsDescription';
-import requireReturnsType from './rules/requireReturnsType';
-import requireThrows from './rules/requireThrows';
-import requireYields from './rules/requireYields';
-import requireYieldsCheck from './rules/requireYieldsCheck';
-import sortTags from './rules/sortTags';
-import tagLines from './rules/tagLines';
-import textEscaping from './rules/textEscaping';
-import validTypes from './rules/validTypes';
+import checkAccess from './rules/checkAccess.js';
+import checkAlignment from './rules/checkAlignment.js';
+import checkExamples from './rules/checkExamples.js';
+import checkIndentation from './rules/checkIndentation.js';
+import checkLineAlignment from './rules/checkLineAlignment.js';
+import checkParamNames from './rules/checkParamNames.js';
+import checkPropertyNames from './rules/checkPropertyNames.js';
+import checkSyntax from './rules/checkSyntax.js';
+import checkTagNames from './rules/checkTagNames.js';
+import checkTypes from './rules/checkTypes.js';
+import checkValues from './rules/checkValues.js';
+import emptyTags from './rules/emptyTags.js';
+import implementsOnClasses from './rules/implementsOnClasses.js';
+import importsAsDependencies from './rules/importsAsDependencies.js';
+import informativeDocs from './rules/informativeDocs.js';
+import matchDescription from './rules/matchDescription.js';
+import matchName from './rules/matchName.js';
+import multilineBlocks from './rules/multilineBlocks.js';
+import noBadBlocks from './rules/noBadBlocks.js';
+import noBlankBlockDescriptions from './rules/noBlankBlockDescriptions.js';
+import noBlankBlocks from './rules/noBlankBlocks.js';
+import noDefaults from './rules/noDefaults.js';
+import noMissingSyntax from './rules/noMissingSyntax.js';
+import noMultiAsterisks from './rules/noMultiAsterisks.js';
+import noRestrictedSyntax from './rules/noRestrictedSyntax.js';
+import noTypes from './rules/noTypes.js';
+import noUndefinedTypes from './rules/noUndefinedTypes.js';
+import requireAsteriskPrefix from './rules/requireAsteriskPrefix.js';
+import requireDescription from './rules/requireDescription.js';
+import requireDescriptionCompleteSentence from './rules/requireDescriptionCompleteSentence.js';
+import requireExample from './rules/requireExample.js';
+import requireFileOverview from './rules/requireFileOverview.js';
+import requireHyphenBeforeParamDescription from './rules/requireHyphenBeforeParamDescription.js';
+import requireJsdoc from './rules/requireJsdoc.js';
+import requireParam from './rules/requireParam.js';
+import requireParamDescription from './rules/requireParamDescription.js';
+import requireParamName from './rules/requireParamName.js';
+import requireParamType from './rules/requireParamType.js';
+import requireProperty from './rules/requireProperty.js';
+import requirePropertyDescription from './rules/requirePropertyDescription.js';
+import requirePropertyName from './rules/requirePropertyName.js';
+import requirePropertyType from './rules/requirePropertyType.js';
+import requireReturns from './rules/requireReturns.js';
+import requireReturnsCheck from './rules/requireReturnsCheck.js';
+import requireReturnsDescription from './rules/requireReturnsDescription.js';
+import requireReturnsType from './rules/requireReturnsType.js';
+import requireThrows from './rules/requireThrows.js';
+import requireYields from './rules/requireYields.js';
+import requireYieldsCheck from './rules/requireYieldsCheck.js';
+import sortTags from './rules/sortTags.js';
+import tagLines from './rules/tagLines.js';
+import textEscaping from './rules/textEscaping.js';
+import validTypes from './rules/validTypes.js';
 
 /**
- * @type {import('eslint').ESLint.Plugin}
+ * @type {import('eslint').ESLint.Plugin & {
+ *   configs: Record<string, import('eslint').ESLint.ConfigData>
+ * }}
  */
 const index = {
   configs: {},

src/iterateJsdoc.js

@@ -1,4 +1,4 @@
-import jsdocUtils from './jsdocUtils';
+import jsdocUtils from './jsdocUtils.js';
 import {
   commentHandler,
   getJSDocComment,

src/jsdocUtils.js

@@ -1,14 +1,14 @@
-import getDefaultTagStructureForMode from './getDefaultTagStructureForMode';
+import getDefaultTagStructureForMode from './getDefaultTagStructureForMode.js';
 import {
   closureTags,
   jsdocTags,
   typeScriptTags,
-} from './tagNames';
+} from './tagNames.js';
 import {
   hasReturnValue,
   hasValueOrExecutorHasNonEmptyResolveValue,
-} from './utils/hasReturnValue';
-import WarnSettings from './WarnSettings';
+} from './utils/hasReturnValue.js';
+import WarnSettings from './WarnSettings.js';
 import {
   tryParse,
 } from '@es-joy/jsdoccomment';

src/rules/checkAccess.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 const accessLevels = [
   'package', 'private', 'protected', 'public',

src/rules/checkAlignment.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 /**
  * @param {string} string

src/rules/checkExamples.js

@@ -1,6 +1,6 @@
 // Todo: When replace `CLIEngine` with `ESLint` when feature set complete per https://github.com/eslint/eslint/issues/14745
 // https://github.com/eslint/eslint/blob/master/docs/user-guide/migrating-to-7.0.0.md#-the-cliengine-class-has-been-deprecated
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 import {
   // @ts-expect-error - For older ESLint
   CLIEngine,

src/rules/checkIndentation.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 /**
  * @param {string} str

src/rules/checkLineAlignment.js

@@ -1,5 +1,5 @@
-import alignTransform from '../alignTransform';
-import iterateJsdoc from '../iterateJsdoc';
+import alignTransform from '../alignTransform.js';
+import iterateJsdoc from '../iterateJsdoc.js';
 import {
   transforms,
 } from 'comment-parser';

src/rules/checkParamNames.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 /**
  * @param {string} targetTagName

src/rules/checkPropertyNames.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 /**
  * @param {string} targetTagName

src/rules/checkSyntax.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 export default iterateJsdoc(({
   jsdoc,

src/rules/checkTagNames.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 import escapeStringRegexp from 'escape-string-regexp';
 
 // https://babeljs.io/docs/en/babel-plugin-transform-react-jsx/

src/rules/checkTypes.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 import {
   parse,
   stringify,

src/rules/checkValues.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 import semver from 'semver';
 import spdxExpressionParse from 'spdx-expression-parse';
 

src/rules/emptyTags.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 const defaultEmptyTags = new Set([
   'abstract', 'async', 'generator', 'global', 'hideconstructor',

src/rules/implementsOnClasses.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 export default iterateJsdoc(({
   report,

src/rules/importsAsDependencies.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 import {
   parse,
   traverse,

src/rules/informativeDocs.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 import {
   areDocsInformative,
 } from 'are-docs-informative';

src/rules/matchDescription.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 // If supporting Node >= 10, we could loosen the default to this for the
 //   initial letter: \\p{Upper}

src/rules/matchName.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 // eslint-disable-next-line complexity
 export default iterateJsdoc(({

src/rules/multilineBlocks.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 export default iterateJsdoc(({
   context,

src/rules/noBadBlocks.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 import {
   parse as commentParser,
 } from 'comment-parser';

src/rules/noBlankBlockDescriptions.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 const anyWhitespaceLines = /^\s*$/u;
 const atLeastTwoLinesWhitespace = /^[ \t]*\n[ \t]*\n\s*$/u;

src/rules/noBlankBlocks.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 export default iterateJsdoc(({
   context,

src/rules/noDefaults.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 export default iterateJsdoc(({
   context,

src/rules/noMissingSyntax.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 /**
  * @typedef {{

src/rules/noMultiAsterisks.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 const middleAsterisksBlockWS = /^([\t ]|\*(?!\*))+/u;
 const middleAsterisksNoBlockWS = /^\*+/u;

src/rules/noRestrictedSyntax.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 export default iterateJsdoc(({
   context,

src/rules/noTypes.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 /**
  * @param {import('comment-parser').Line} line

src/rules/noUndefinedTypes.js

@@ -1,6 +1,6 @@
 import iterateJsdoc, {
   parseComment,
-} from '../iterateJsdoc';
+} from '../iterateJsdoc.js';
 import {
   getJSDocComment,
   parse as parseType,

src/rules/requireAsteriskPrefix.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 export default iterateJsdoc(({
   context,

src/rules/requireDescription.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 /**
  * @param {string} description

src/rules/requireDescriptionCompleteSentence.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 import escapeStringRegexp from 'escape-string-regexp';
 
 const otherDescriptiveTags = new Set([

src/rules/requireExample.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 export default iterateJsdoc(({
   context,

src/rules/requireFileOverview.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 const defaultTags = {
   file: {

src/rules/requireHyphenBeforeParamDescription.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 export default iterateJsdoc(({
   sourceCode,

src/rules/requireJsdoc.js

@@ -1,8 +1,8 @@
-import exportParser from '../exportParser';
+import exportParser from '../exportParser.js';
 import {
   getSettings,
-} from '../iterateJsdoc';
-import jsdocUtils from '../jsdocUtils';
+} from '../iterateJsdoc.js';
+import jsdocUtils from '../jsdocUtils.js';
 import {
   getDecorator,
   getJSDocComment,

src/rules/requireParam.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 /**
  * @typedef {[string, boolean, () => RootNamerReturn]} RootNamerReturn

src/rules/requireParamDescription.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 export default iterateJsdoc(({
   context,

src/rules/requireParamName.js

@@ -1,4 +1,4 @@
-import iterateJsdoc from '../iterateJsdoc';
+import iterateJsdoc from '../iterateJsdoc.js';
 
 export default iterateJsdoc(({
   report,