Merge pull request #66 from darkmavis1980/feature/upgrade-linting

Feature/upgrade linting

Author: darkmavis1980

.github/workflows/main.yml

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ 18, 20 ]
+        node: [ 20, 22 ]
     # Steps represent a sequence of tasks that will be executed as part of the job
     name: Build for Node ${{ matrix.node }} version
     steps:

.github/workflows/pr.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ 18, 20 ]
+        node: [ 20, 22 ]
 
     name: Build for Node ${{ matrix.node }} version
     steps:

.github/workflows/release.yml

@@ -10,7 +10,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 22
           registry-url: 'https://registry.npmjs.org'
       - run: npm install
       - run: npm publish

.gitignore

@@ -9,4 +9,5 @@ node_modules
 .npmrc
 coverage
 .DS_Store
-.vscode
+.vscode
+tsconfig.tsbuildinfo

.mocharc.json

@@ -0,0 +1,11 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "printWidth": 120,
+  "bracketSpacing": true,
+  "arrowParens": "avoid",
+  "endOfLine": "lf",
+  "singleAttributePerLine": true
+}

.prettierrc

@@ -1,6 +1,25 @@
 # Changelog
 
-## [v2.1.1](https://github.com/darkmavis1980/markdown-index-generator/compare/v2.1.0...v2.1.1)
+## [v3.0.0](https://github.com/darkmavis1980/markdown-index-generator/compare/v2.1.1...v3.0.0)
+
+### Merged
+
+- Bugfix/fix issue with title [`#65`](https://github.com/darkmavis1980/markdown-index-generator/pull/65)
+
+### Commits
+
+- feat: remove legacy packages [`90b249e`](https://github.com/darkmavis1980/markdown-index-generator/commit/90b249eb537b1efc283556383c4baf9f5beffcbd)
+- chore: update dependency [`5f5bcc6`](https://github.com/darkmavis1980/markdown-index-generator/commit/5f5bcc6ba28818d549e84f90fb01bb2ea61032b9)
+- feat: add tsx [`fb3a425`](https://github.com/darkmavis1980/markdown-index-generator/commit/fb3a4255b321a005431147b09c432c3f3b16a75b)
+- fix: add missing package [`1db784c`](https://github.com/darkmavis1980/markdown-index-generator/commit/1db784c2a921996e64fddf11e1114c1f7b967b01)
+- fix: cleaned up code [`ce7e97b`](https://github.com/darkmavis1980/markdown-index-generator/commit/ce7e97b3fb21ae5e71cf13bd2b1d8a1084313690)
+- fix: add missing package [`c024b12`](https://github.com/darkmavis1980/markdown-index-generator/commit/c024b12d378c845a1434a0ff837257f69a3e5326)
+- feat: add prettier [`67ee3c5`](https://github.com/darkmavis1980/markdown-index-generator/commit/67ee3c5de749eaf9a6045aa9b5c1e8aed55f7255)
+- feat: upgrade commander to latest version [`d99fb91`](https://github.com/darkmavis1980/markdown-index-generator/commit/d99fb910b49af7500eb50938f08726c3854b4dec)
+- chore: removed legacy mocha configuration [`5c77682`](https://github.com/darkmavis1980/markdown-index-generator/commit/5c776828935a92136f5bfc1d492b20c0fe40c4f6)
+- fix: update code to use ESM [`5443145`](https://github.com/darkmavis1980/markdown-index-generator/commit/5443145531ebdca5c5890b30b5086e4c4a31a126)
+
+## [v2.1.1](https://github.com/darkmavis1980/markdown-index-generator/compare/v2.1.0...v2.1.1) - 2024-07-31
 
 ### Merged
 

CHANGELOG.md

@@ -1,8 +1,8 @@
-#!/usr/bin/env node
+#!/usr/bin/env npx tsx
 
-const { program } = require('commander');
-const { version } = require('../package.json');
-const MarkdownIndexGenerator = require('../lib/index.js');
+import { program } from 'commander';
+import { version } from '../package.json';
+import MarkdownIndexGenerator from '../lib/index.js';
 
 program
   .version(version)

babel.config.js

@@ -1,39 +1,63 @@
-import typescriptEslint from "@typescript-eslint/eslint-plugin";
-import tsParser from "@typescript-eslint/parser";
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-import js from "@eslint/js";
-import { FlatCompat } from "@eslint/eslintrc";
+import importPlugin from 'eslint-plugin-import';
+import globals from 'globals';
+import tsParser from '@typescript-eslint/parser';
+import eslintJs from '@eslint/js';
+import eslintTs from 'typescript-eslint';
 
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-const compat = new FlatCompat({
-    baseDirectory: __dirname,
-    recommendedConfig: js.configs.recommended,
-    allConfig: js.configs.all
-});
+const tsFiles = ['{src,test}/**/*.ts'];
 
-export default [{
-    ignores: ["lib", "**/*.d.ts"],
-}, ...compat.extends(
-    "eslint:recommended",
-    "plugin:@typescript-eslint/eslint-recommended",
-    "plugin:@typescript-eslint/recommended",
-).map(config => ({
-    ...config,
-    files: ["**/*.ts", "**/*.tsx"],
-})), {
-    files: ["**/*.ts", "**/*.tsx"],
+const languageOptions = {
+    globals: {
+        ...globals.node,
+        ...globals.jest,
+    },
+    ecmaVersion: 2023,
+    sourceType: 'module',
+};
 
+const customTypescriptConfig = {
+    files: tsFiles,
     plugins: {
-        "@typescript-eslint": typescriptEslint,
+        import: importPlugin,
+        'import/parsers': tsParser,
     },
-
     languageOptions: {
+        ...languageOptions,
         parser: tsParser,
+        parserOptions: {
+            project: './tsconfig.json',
+        },
+    },
+    settings: {
+        'import/parsers': {
+            '@typescript-eslint/parser': ['.ts'],
+        },
     },
-
     rules: {
         "no-console": "off",
+        "@typescript-eslint/no-explicit-any": "off",
     },
-}];
+    ignores: ['/lib'],
+};
+
+// Add the files for applying the recommended TypeScript configs 
+// only for the Typescript files.
+// This is necessary when we have the multiple extensions files 
+// (e.g. .ts, .tsx, .js, .cjs, .mjs, etc.).
+const recommendedTypeScriptConfigs = [
+    ...eslintTs.configs.recommended.map((config) => ({
+        ...config,
+        files: tsFiles,
+    })),
+    ...eslintTs.configs.stylistic.map((config) => ({
+        ...config,
+        files: tsFiles,
+    })),
+];
+
+export default [
+    { ignores: ['docs/*', 'build/*', 'lib/*', 'dist/*'] }, // global ignores
+    eslintJs.configs.recommended,
+    ...recommendedTypeScriptConfigs,
+    customTypescriptConfig,
+];