ci: ensure ci runs lint and make lint pass

nginx · Jul 17, 2023 · 8a9afc2 · 8a9afc2
1 parent 83904af
commit 8a9afc2
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 45 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -4,6 +4,10 @@
     "plugin:@typescript-eslint/recommended",
     "plugin:prettier/recommended"
   ],
+  "ignorePatterns": ["**/node_modules/", "/dist/", "/lib/"],
+  "parserOptions": {
+    "sourceType": "module"
+  },
   "rules": {
     "@typescript-eslint/no-unused-vars": [
       "warn",

diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -9,10 +9,7 @@ jobs:
     strategy:
       matrix:
         nginx-version:
-          - 1.18.x
-          - 1.20.x
-          - 1.21.x
-          - 1.22.x
+          - 1.25.x
     env:
       NGINX_VERSION: ${{ matrix.nginx-version }}
     runs-on: ubuntu-latest
@@ -21,7 +18,7 @@ jobs:
       - name: Install dependencies
         run: sudo apt-get install -y ca-certificates
       - uses: actions/setup-node@v3
-      - run: npm install
+      - run: npm ci
+      - run: npm run lint
       - run: npm run build
       - run: npm run test
-      # - run: npm run lint
diff --git a/babel.config.js b/babel.config.js
@@ -2,6 +2,7 @@
 // @ts-check
 
 /** @type {babel.ConfigFunction} */
+// eslint-disable-next-line no-undef
 module.exports = (api) => ({
   presets: [
     // Transpile modern JavaScript into code compatible with njs.

diff --git a/package.json b/package.json
@@ -25,8 +25,7 @@
     "build": "rollup -c --environment NODE_ENV:dev",
     "clean": "rimraf dist/* lib/* node_modules/.cache/*",
     "lint": "run-p lint:*",
-    "lint:eslint": "eslint --cache --cache-location node_modules/.cache/eslint --ext .ts,.js .",
-    "lint:types": "tsc -b",
+    "lint:eslint": "npx eslint .",
     "prepublishOnly": "run-s build && asciidoctor -b docbook -a npm-readme -a gh-branch=v$npm_package_version -o - README.adoc | pandoc -f docbook -t gfm --base-header-level 2 -o README.md",
     "start": "run-p watch start-nginx",
     "start-nginx": "start-nginx --version 1.24.x --port 8090 --watch dist/ integration-tests/nginx.conf",

diff --git a/rollup.config.js b/rollup.config.js
@@ -3,12 +3,12 @@ import addGitMsg from 'rollup-plugin-add-git-msg'
 import babel from '@rollup/plugin-babel'
 import commonjs from '@rollup/plugin-commonjs'
 import resolve from '@rollup/plugin-node-resolve'
-import json from "@rollup/plugin-json";
+import json from '@rollup/plugin-json'
 import pkg from './package.json'
 
-
 // List of njs built-in modules.
 const njsExternals = ['crypto', 'fs', 'querystring']
+// eslint-disable-next-line no-undef
 const isEnvProd = process.env.NODE_ENV === 'production'
 
 /**
@@ -18,44 +18,46 @@ const isEnvProd = process.env.NODE_ENV === 'production'
  * @return {import('rollup').OutputPlugin}
  */
 const fixExportDefault = () => ({
-    name: 'fix-export-default',
-    renderChunk: (code) => ({
-        code: code.replace(/\bexport { (\S+) as default };/, 'export default $1;'),
-        map: null,
-    }),
+  name: 'fix-export-default',
+  renderChunk: (code) => ({
+    code: code.replace(/\bexport { (\S+) as default };/, 'export default $1;'),
+    map: null,
+  }),
 })
 
 /**
  * @type {import('rollup').RollupOptions}
  */
 const options = {
-    input: 'src/index.ts',
-    external: njsExternals,
-    plugins: [
-        // Transpile TypeScript sources to JS.
-        babel({
-            babelHelpers: 'bundled',
-            envName: 'njs',
-            extensions: ['.ts', '.mjs', '.js'],
-        }),
-        // Resolve node modules.
-        resolve({
-            extensions: ['.mjs', '.js', '.json', '.ts'],
-        }),
-        json(),
-        // Convert CommonJS modules to ES6 modules.
-        commonjs(),
-        // Fix syntax of the default export.
-        fixExportDefault(),
-        // Plugins to use in production mode only.
-        ...isEnvProd ? [
-            // Add git tag, commit SHA, build date and copyright at top of the file.
-            addGitMsg(),
-        ] : [],
-    ],
-    output: {
-        file: pkg.main,
-        format: 'es',
-    },
+  input: 'src/index.ts',
+  external: njsExternals,
+  plugins: [
+    // Transpile TypeScript sources to JS.
+    babel({
+      babelHelpers: 'bundled',
+      envName: 'njs',
+      extensions: ['.ts', '.mjs', '.js'],
+    }),
+    // Resolve node modules.
+    resolve({
+      extensions: ['.mjs', '.js', '.json', '.ts'],
+    }),
+    json(),
+    // Convert CommonJS modules to ES6 modules.
+    commonjs(),
+    // Fix syntax of the default export.
+    fixExportDefault(),
+    // Plugins to use in production mode only.
+    ...(isEnvProd
+      ? [
+          // Add git tag, commit SHA, build date and copyright at top of the file.
+          addGitMsg(),
+        ]
+      : []),
+  ],
+  output: {
+    file: pkg.main,
+    format: 'es',
+  },
 }
 export default options
diff --git a/src/x509.js b/src/x509.js
@@ -1,3 +1,5 @@
+/* eslint-disable no-fallthrough */
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
 /**
  * this is from https://github.com/nginx/njs-examples/blob/master/njs/http/certs/js/x509.js
  *
@@ -370,6 +372,7 @@ function parse_pem_cert(pem) {
     der = der.slice(1, -2)
   }
 
+  // eslint-disable-next-line no-undef
   return asn1_read(Buffer.from(der.join(''), 'base64'))
 }
 

diff --git a/unit-tests/tsconfig.json b/unit-tests/tsconfig.json
@@ -1,6 +1,13 @@
 {
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "types": ["node", "njs-types"]
-  }
+    "types": ["njs-types", "node"]
+  },
+  "files": [
+    "../node_modules/njs-types/ngx_http_js_module.d.ts",
+    "../node_modules/njs-types/njs_webcrypto.d.ts",
+    "../node_modules/njs-types/njs_core.d.ts",
+    "../node_modules/njs-types/njs_modules/crypto.d.ts",
+    "../node_modules/njs-types/njs_modules/fs.d.ts"
+  ]
 }