Native ESM

Signed-off-by: Sora Morimoto <sora@morimoto.io>

Author: smorimoto

.eslintrc.json

@@ -1,6 +1,6 @@
 name: Example Dependency Submission
-on:
-  push
+
+on: push
 
 permissions:
   contents: write
@@ -9,21 +9,19 @@ jobs:
   example-submission:
     runs-on: ubuntu-latest
     steps:
-      - name: 'Checkout Repository'
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v4
+
       - uses: actions/setup-node@v4
-      # As of 2023-02-22, the ubuntu-latest image uses npm v8.3.1. This version
-      # has a bug that prevents loading dependency-submission-toolkit in the
-      # 'example/' project. npm v8.4.1 (same version in Codespace created on
-      # same date) is known to work. Not pinned to latest to avoid
-      # reproducibility issues.
-      - run: npm install npm@8.4.1 -g
-      - name: Install NPM dependencies
-        run: npm ci
-      - name: Run all NPM build/test actions
-        run: npm -w:example rebuild && npm run all -w:example
+        with:
+          node-version: 20
+
+      - run: npm ci
+
+      - run: npm run all
+
+      - run: npm run all:example
+
       - name: Run dependency submission
         uses: ./
-        id: example
         with:
           npm-package-directory: ./

.github/workflows/dependency-submission-example.yml

@@ -8,19 +8,21 @@ jobs:
   publish-npm:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout the project
-        uses: actions/checkout@v4
-      - name: Use Node.js 16.x (LTS)
-        uses: actions/setup-node@v4
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
         with:
-          node-version: 16.x
-          registry-url: https://registry.npmjs.org/
-          cache: npm
+          node-version: 20
+          registry-url: https://registry.npmjs.org
+
       - run: npm ci
+
       - run: npm test
+
       - run: npm version ${TAG_NAME} --git-tag-version=false --allow-same-version
         env:
           TAG_NAME: ${{ github.event.release.tag_name }}
+
       - run: npm whoami; npm publish --access public
         env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
+          NODE_AUTH_TOKEN: ${{ secrets.npm_token }}

.github/workflows/publish.yml

@@ -1,27 +1,25 @@
-name: 'build-test'
+name: build-test
+
 on: # rebuild any PRs and main branch changes
   pull_request:
-   branches:
+    branches:
       - main
-      - 'releases/*'
+      - releases/*
   push:
     branches:
       - main
-      - 'releases/*'
+      - releases/*
 
 jobs:
   build: # make sure build/ci work properly
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      # As of 2023-02-22, the ubuntu-latest image uses npm v8.3.1. This version
-      # has a bug that prevents loading dependency-submission-toolkit in the
-      # 'example/' project. npm v8.4.1 (same version in Codespace created on
-      # same date) is known to work. Not pinned to latest to avoid
-      # reproducibility issues.
-      - run: npm install npm@8.4.1 -g
-      - name: Install NPM dependencies
-        run: npm ci
-      - run: npm install
-      - name: Run all NPM build/test actions
-        run: npm rebuild && npm run all
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - run: npm ci
+
+      - run: npm run all

.github/workflows/test.yml

@@ -1,14 +1,14 @@
-name: 'Example Dependency Submission Action'
-description: 'Example action using the dependency-submission-toolkit and npm'
+name: Example Dependency Submission Action
+description: Example action using the dependency-submission-toolkit and npm
 inputs:
   token:
-    description: "GitHub Personal Access Token (PAT). Defaults to PAT provided by Action runner"
+    description: GitHub Personal Access Token (PAT). Defaults to PAT provided by Action runner
     required: false
     default: ${{ github.token }}
   npm-package-directory:
-    description: 'NPM package directory (directory with package.json)'
+    description: NPM package directory (directory with package.json)
     required: true
-    default: './'
+    default: ./
 runs:
-  using: 'node16'
-  main: 'example/action-dist/index.js'
+  using: node20
+  main: example/dist/index.js

.npmignore

@@ -0,0 +1,31 @@
+{
+  "$schema": "node_modules/@biomejs/biome/configuration_schema.json",
+  "files": {
+    "ignoreUnknown": true
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space"
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "semicolons": "asNeeded",
+      "trailingComma": "none"
+    }
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true
+    }
+  },
+  "organizeImports": {
+    "enabled": true
+  },
+  "vcs": {
+    "clientKind": "git",
+    "enabled": true,
+    "useIgnoreFile": true
+  }
+}

.prettierignore

@@ -1,3 +1,3 @@
-import { main } from './npm-detector'
+import { main } from './npm-detector.js'
 
 main()