create-node-lib 2.8.1 → 2.9.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-node-lib",
-  "version": "2.8.1",
+  "version": "2.9.1",
   "description": "Scaffolding out a Node.js library module",
   "bin": "./bin/cli.js",
   "engines": {

package/template/.github/dependabot.yml

@@ -17,6 +17,11 @@ updates:
     schedule:
       interval: "weekly"
     open-pull-requests-limit: 10
+    # Use the 'dependencies' default label and add
+    # the 'automerge' one for automerge github action support
+    labels:
+      - "dependencies"
+      - "automerge"
     groups:
       # Production dependencies without breaking changes
       dependencies:

package/template/.github/workflows/automerge.yml

@@ -0,0 +1,39 @@
+name: automerge
+on:
+  pull_request:
+    types:
+      - labeled
+      - unlabeled
+      - synchronize
+      - opened
+      - edited
+      - ready_for_review
+      - reopened
+      - unlocked
+  pull_request_review:
+    types:
+      - submitted
+  check_suite:
+    types:
+      - completed
+  status: {}
+jobs:
+  automerge:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - id: automerge
+        name: automerge
+        uses: "pascalgn/automerge-action@v0.16.4"
+        env:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          # we only merge PRs with labels of "dependencies" 
+          MERGE_LABELS: "automerge"
+          MERGE_REMOVE_LABELS: "automerge"
+          MERGE_METHOD: "squash"
+          MERGE_COMMIT_MESSAGE: "automatic"
+          MERGE_FORKS: "false"
+          MERGE_REQUIRED_APPROVALS: "0"
+          UPDATE_METHOD: "rebase"

package/template/.github/workflows/markdown-lint.yml

@@ -13,14 +13,11 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Markdown Lint
-        uses: ruzickap/action-my-markdown-linter@26b4129bf0352527e60b5bd739357af63df1b7bf
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
-          debug: true
-          config_file: .github/.markdownlint.yml
-          exclude: |
-            .changeset/
-            .github/
-            CODE_OF_CONDUCT.md
-            LICENSE
-            CHANGELOG.md
+          node-version: '22'
+
+      - name: Markdown Lint
+        run: |
+          npm run lint:markdown || npx -y markdownlint-cli@0.45.0 -c .github/.markdownlint.yml -i '.git' -i '__tests__' -i '.github' -i '.changeset' -i 'CODE_OF_CONDUCT.md' -i 'CHANGELOG.md' -i 'node_modules' -i 'dist' '**/**.md'

package/template/eslint.config.js

@@ -3,7 +3,7 @@ import neostandard, { resolveIgnoresFromGitignore, plugins } from 'neostandard'
 
 export default [
   ...neostandard({
-    ignores: resolveIgnoresFromGitignore(),
+    ignores: ['__tests__/**/*.ts', ...resolveIgnoresFromGitignore()],
     ts: true,   // Enable TypeScript support,
     filesTs: ['src/**/*.ts', '__tests__/**/*.ts']
   }),
@@ -11,10 +11,10 @@ export default [
   pluginSecurity.configs.recommended,
   {
     rules: {
-      'n/no-process-exit': 'warn',
+      'n/no-process-exit': 'off',
       'n/no-unsupported-features': 'off',
       'n/no-unpublished-require': 'off',
-      'security/detect-non-literal-fs-filename': 'error',
+      'security/detect-non-literal-fs-filename': 'off',
       'security/detect-unsafe-regex': 'error',
       'security/detect-buffer-noassert': 'error',
       'security/detect-child-process': 'error',
@@ -22,16 +22,18 @@ export default [
       'security/detect-eval-with-expression': 'error',
       'security/detect-no-csrf-before-method-override': 'error',
       'security/detect-non-literal-regexp': 'error',
-      'security/detect-object-injection': 'warn',
+      'security/detect-object-injection': 'off',
       'security/detect-possible-timing-attacks': 'error',
       'security/detect-pseudoRandomBytes': 'error',
       'space-before-function-paren': 'off',
       'object-curly-spacing': 'off',
-      'n/hashbang': 'off'
+      'no-control-regex': 'off',
+      'n/hashbang': 'off',
+      'n/no-unsupported-features/node-builtins': 'warn'
     },
     languageOptions: {
       ecmaVersion: 2024,
       sourceType: 'module',
     },
   },
-]
+]

package/template/package.json

@@ -35,7 +35,8 @@
   "scripts": {
     "start": "node --import tsx src/bin/cli.ts",
     "build": "tsc && tsup",
-    "lint": "eslint . && npm run lint:lockfile",
+    "lint": "eslint . && npm run lint:lockfile && npm run lint:markdown",
+    "lint:markdown": "npx -y markdownlint-cli@0.45.0 -c .github/.markdownlint.yml -i '.git' -i '__tests__' -i '.github' -i '.changeset' -i 'CODE_OF_CONDUCT.md' -i 'CHANGELOG.md' -i 'docs/**' -i 'node_modules' -i 'dist' '**/**.md' --fix",
     "lint:fix": "eslint . --fix",
     "lint:lockfile": "lockfile-lint --path package-lock.json --validate-https --allowed-hosts npm yarn",
     "test": "c8 node --import tsx --test __tests__/**/*.test.ts",
@@ -85,5 +86,22 @@
     "**/*.{js,json}": [
       "npm run lint:fix"
     ]
+  },
+    "c8": {
+    "exclude": [
+      "dist/**",
+      "coverage/**",
+      "__tests__/**",
+      "**/*.test.ts",
+      "**/*.test.js"
+    ],
+    "include": [
+      "src/**"
+    ],
+    "reporter": [
+      "text",
+      "lcov",
+      "html"
+    ]
   }
 }

package/template/src/bin/cli.ts

@@ -5,8 +5,8 @@ import { add } from '../main.ts'
 const debug = debuglog('<%= projectName %>')
 
 async function init () {
-    const sum = await add(1, 2)
-    debug(sum.toString())
+  const sum = await add(1, 2)
+  debug(sum.toString())
 }
 
 init()

package/template/src/main.ts

@@ -1,3 +1,3 @@
-export async function add(arg1: number, arg2: number): Promise<number> {
+export async function add (arg1: number, arg2: number): Promise<number> {
   return Promise.resolve(arg1 + arg2)
 }