Merge pull request #1 from NullVoxPopuli/prepare-for-plugin-consumers

Prepare for plugin consumers

.eslintrc.cjs

@@ -0,0 +1,6 @@
+'use strict';
+
+const { configs } = require('@nullvoxpopuli/eslint-configs');
+
+// accommodates: JS, TS, ESM, and CJS
+module.exports = configs.node();

.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request: {}
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+      - uses: wyvox/action-setup-pnpm@v3
+      - name: Lint
+        run: pnpm lint

.gitignore

@@ -1 +1,2 @@
 node_modules/
+.eslintcache

.prettierignore

@@ -0,0 +1,2 @@
+*.yaml
+*.yml

.prettierrc.cjs

@@ -0,0 +1,21 @@
+'use strict';
+
+module.exports = {
+  printWidth: 100,
+  overrides: [
+    {
+      // Lol, JavaScript
+      files: ['*.js', '*.ts', '*.cjs', '.mjs', '.cts', '.mts', '.cts'],
+      options: {
+        singleQuote: true,
+        trailingComma: 'es5',
+      },
+    },
+    {
+      files: ['*.json'],
+      options: {
+        singleQuote: false,
+      },
+    },
+  ],
+};

README.md

@@ -8,10 +8,21 @@ Why fix anything, when we can post-process!
 
 ## Usage
 
-```bash 
+### CLI
+
+```bash
 npx fix-bad-declaration-output './declarations/**/*.d.ts'
 ```
 
+### JS
+
+```js
+import { fixBadDeclarationOutput } from "fix-bad-declaration-output";
+
+await fixBadDeclarationOutput("./declarations/**/*.d.ts", ["TypeScript#56571", "Glint#628"]);
+```
+
+At least one fixer is required to be specified in the second argument.
 
 ## Current Fixes
 
@@ -23,6 +34,6 @@ TypeScript does not tell you why anything happens, and because, in Ember, we can
 
 ### Rewrite imports ending with `.gts`
 
-In modern tooling, extensions are included in the import paths to help with understanding of what files imports are pointing to, as well as help reduce complexity in build tooling. 
+In modern tooling, extensions are included in the import paths to help with understanding of what files imports are pointing to, as well as help reduce complexity in build tooling.
 
 See [This Glint Issue](https://github.com/typed-ember/glint/issues/628) as well as some relevant discussion in the [Ember Discord](https://discord.com/channels/480462759797063690/568935504288940056/1171838869914779659) for more details on why a fix hasn't landed in Glint (tl;dr: no one knows what to do)

package.json

@@ -2,14 +2,30 @@
   "name": "fix-bad-declaration-output",
   "version": "1.0.0",
   "type": "module",
-  "main": "index.js",
-  "bin": "index.js",
+  "bin": "src/bin.js",
+  "module": "./src/index.js",
+  "exports": {
+    ".": {
+      "default": "./src/index.js"
+    }
+  },
   "scripts": {
+    "lint": "concurrently 'npm:lint:*(!fix)' --names 'lint:'",
+    "lint:fix": "pnpm lint:js:fix && pnpm format:fix",
+    "lint:package": "publint .",
+    "lint:js": "eslint . --cache",
+    "lint:format": "prettier . --check",
+    "format:fix": "prettier . --write",
+    "lint:js:fix": "eslint . --fix",
+    "lint:types": "tsc --noEmit",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [],
   "author": "NullVoxPopuli",
   "license": "MIT",
+  "files": [
+    "src/**"
+  ],
   "publishConfig": {
     "registry": "https://registry.npmjs.org",
     "access": "public"
@@ -18,5 +34,20 @@
     "fs-extra": "^11.2.0",
     "globby": "^14.0.0",
     "jscodeshift": "^0.15.1"
+  },
+  "devDependencies": {
+    "@nullvoxpopuli/eslint-configs": "^3.2.2",
+    "@tsconfig/node21": "^21.0.1",
+    "@tsconfig/strictest": "^2.0.2",
+    "@types/fs-extra": "^11.0.4",
+    "@types/jscodeshift": "^0.11.11",
+    "@types/node": "^20.11.5",
+    "@typescript-eslint/eslint-plugin": "^6.19.1",
+    "@typescript-eslint/parser": "^6.19.1",
+    "concurrently": "^8.2.2",
+    "eslint": "^8.56.0",
+    "prettier": "^3.2.4",
+    "publint": "^0.2.7",
+    "typescript": "^5.3.3"
   }
 }