Typescript

.github/workflows/node-publish.yml

@@ -0,0 +1,12 @@
+name: publish to npm
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  node-publish:
+    uses: fluidware-team/.github/.github/workflows/node-publish.yml@v1
+    secrets:
+      npm_token: ${{ secrets.NPM_TOKEN }}

.github/workflows/node-test.yml

@@ -1,18 +1,7 @@
-name: lint test
+name: lint test compile
 
 on: push
 
 jobs:
-
-  test:
-    runs-on: ubuntu-22.04
-    steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js 18.x
-        uses: actions/setup-node@v2
-        with:
-          node-version: '18'
-      - run: npm ci
-      - run: npm run lint
-      - run: npm test
-      - run: npm run build
+  node-lint-test-compile:
+    uses: fluidware-team/.github/.github/workflows/node-test.yml@v1

.gitignore

@@ -104,3 +104,6 @@ es/
 # TernJS port file
 .tern-port
 xunit.xml
+
+build/
+src/version.ts

.npmrc

@@ -0,0 +1,3 @@
+fund=false
+update-notifier=false
+save-exact=true

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "singleQuote": true,
+  "arrowParens": "avoid",
+  "printWidth": 120,
+  "bracketSpacing": true,
+  "trailingComma": "none"
+}

eslint.config.mjs

@@ -0,0 +1,85 @@
+import globals from 'globals';
+import pluginJs from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import pluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+import nodePlugin from 'eslint-plugin-n';
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+  {
+    name: 'ignore files',
+    ignores: ['dist/', 'build/', 'reports/', 'node_modules/']
+  },
+  {
+    name: 'include files',
+    files: ['**/*.{js,mjs,cjs,ts}']
+  },
+  {
+    name: 'globals for node',
+    files: ['**/*.{mjs,cjs,ts}'],
+    languageOptions: { globals: globals.node }
+  },
+  {
+    ...pluginJs.configs.recommended,
+    name: 'plugin-js recommended'
+  },
+  {
+    ...nodePlugin.configs['flat/recommended-module'],
+    name: 'custom eslint-plugin-n plugin config',
+    files: ['**/*.ts'],
+    rules: {
+      'n/no-process-env': 'error',
+      'n/no-missing-import': [
+        'off', // eslint-plugin-n fails to resolve index.ts files
+        {
+          tryExtensions: ['.ts', '.d.ts']
+        }
+      ]
+    },
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        NodeJS: true
+      }
+    }
+  },
+  {
+    ...nodePlugin.configs['flat/recommended-module'],
+    name: 'custom eslint-plugin-n plugin config for tests',
+    files: ['tests*/**/*.ts'],
+    // eslint-plugin-n rules
+    rules: {
+      'n/no-process-env': 'off'
+    },
+    languageOptions: {
+      globals: {
+        ...globals.jest
+      }
+    }
+  },
+  ...tseslint.configs.recommended.map(config => ({
+    ...config,
+    files: ['**/*.ts'],
+    rules: {
+      'no-unused-vars': 'off',
+      'no-redeclare': 'off',
+      '@typescript-eslint/no-redeclare': 'error',
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          argsIgnorePattern: '^_',
+          caughtErrorsIgnorePattern: '^_'
+        }
+      ]
+    }
+  })),
+  {
+    // eslint core rules
+    rules: {
+      complexity: ['error', 10],
+      'no-console': 'error',
+      eqeqeq: ['error', 'smart']
+    }
+  },
+  pluginPrettierRecommended
+];

jest.config.mjs

@@ -0,0 +1,9 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+export default {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  collectCoverage: true,
+  collectCoverageFrom: ['src/**/*.ts'],
+  coverageDirectory: 'reports/coverage',
+  coverageReporters: ['text', 'text-summary', 'cobertura']
+};