Skip to content

Convert project to ES modules (align tooling with the service repo)#276

Open
bickelj-agent wants to merge 2 commits into
mainfrom
convert-cjs-to-esm
Open

Convert project to ES modules (align tooling with the service repo)#276
bickelj-agent wants to merge 2 commits into
mainfrom
convert-cjs-to-esm

Conversation

@bickelj-agent

Copy link
Copy Markdown
Collaborator

This branch moves data-scripts from CommonJS to ES modules, in two reviewable commits, and then aligns its tooling with the service repository. Authored by GLM-5.2.

Why

data-scripts predates the shared, stricter tooling standardized in the service repository. Converting it to ESM in one step, then aligning to that tooling in a second step, keeps each change small and reviewable and lets the ESM conversion stand on its own.

Commit 1 — Convert project to ES modules

Minimal change required by ESM only:

  • Sets "type": "module", so Node resolves .js files as ESM. The already-present nodenext module setting then requires explicit .js suffixes on relative imports, and running the scripts from src/ needs a loader mapping those suffixes back to their .ts source.
  • Adds the ts-node ESM register hook the dev scripts now import, and the .js suffixes on relative imports.
  • Keeps the legacy ESLint config and single tsconfig.json, since they already use nodenext and still lint the ESM source.

Commit 2 — Align tooling with the service repository

Brings data-scripts in line so both repos lint, format, type-check, and test the same way:

  • Flat ESLint 9 config on eslint-config-love; Prettier; split build/type-check tsconfig; Jest in ESM mode; Node 24 engines; .npmrc; lockfile bumped to v3.
  • The pre-existing scripts predate that strictness, so the rules that would force large ESM-unrelated refactors of them are disabled and those files are Prettier-ignored to keep the diff clean.
  • Only the small refactors the kept rules require (node: prefixes, named constants, type-only specifiers) are applied, with unit tests for ein and csv covering the parsing the ESM switch touched.

Verification

  • npm test — 2 suites, 9 tests passed.
  • npm run linteslint ./src --max-warnings=0, prettier --check, and tsc --noEmit all clean.
  • No whitespace-only churn vs main; the pre-existing scripts are Prettier-ignored to avoid polluting future git blame.

Generated-by: GLM-5.2

With `"type": "module"`, Node resolves `.js` files as ESM, so the
already-present `nodenext` setting now requires explicit `.js`
suffixes on relative imports, and running the scripts from `src/`
needs a loader mapping those suffixes back to their `.ts` source.
This change is only what ESM forces (the suffixes, the `ts-node`
ESM register hook the dev scripts now import, and the type field)
so it can stand alone and stay reviewable; the service repo's
broader tooling is deferred to the next commit. The legacy ESLint
config and single tsconfig are kept, since they already use
`nodenext` and still lint the ESM source.

Generated-by: GLM-5.2
@bickelj-agent bickelj-agent changed the title Convert project to ES modules (align tooling with the service repo) Convert project to ES modules (align tooling with the service repo) Jul 22, 2026
@bickelj
bickelj requested review from Copilot and slifty July 22, 2026 18:56
@bickelj

bickelj commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator

I was able to run the charity navigator lookupAll and updateAll commands successfully on each of these commits using the test environment. This PR was basically go bring the repo up to speed for further development on it. I don't know how to do a CJS->ESM conversion myself so I had GLM-5.2 do it, looks pretty minimally invasive.

@slifty @hminsky2002 I don't think it would be best for the one who prompted this PR to also be the one to review this PR, so I would appreciate one of y'all's reviews.

@bickelj
bickelj requested a review from hminsky2002 July 22, 2026 18:58

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request migrates data-scripts from CommonJS to ES modules and then aligns the repo’s TypeScript, linting/formatting, and test tooling with the stricter standards used in the service repository, while minimizing diff churn in pre-existing scripts.

Changes:

  • Switch Node execution and internal imports to ESM ("type": "module", .js import specifiers, ts-node ESM loader hook).
  • Split TypeScript configs into build vs dev/typecheck, and add Jest-based unit tests for key parsing helpers.
  • Replace legacy ESLint config with ESLint 9 flat config + Prettier, plus editor/npm configuration alignment.

Reviewed changes

Copilot reviewed 22 out of 25 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tsconfig.json Introduces build output settings (dist/) and declaration emit for ESM build.
tsconfig.dev.json Adds a dev/typecheck-only TS config used by linting and tests.
src/postProposalVersions.ts Updates Node core imports and ESM-relative import specifiers; replaces inline literals with named constants.
src/pdc-api.ts Updates ESM import specifiers and makes type re-exports explicit.
src/oidc.ts Switches Node core import to node: prefix and adopts type imports for ESM hygiene.
src/index.ts Updates internal imports to .js specifiers required under Node ESM.
src/generateBaseFieldsInserts.ts Converts Node core imports to node: prefix and updates internal imports to .js.
src/generateApplicationFormJson.ts Updates internal imports to .js and corrects axios type-only import usage.
src/ein.unit.test.ts Adds Jest unit tests for EIN validation behavior.
src/csv.unit.test.ts Adds Jest unit tests for CSV row assertion behavior.
src/csv.ts Switches assert import to node: prefix.
src/client.ts Updates internal logger import to .js and uses type-only axios imports.
src/charityNavigator.ts Updates Node/core and internal ESM imports; extracts JSON formatting constants.
src/candid.ts Updates Node/core and internal ESM imports; extracts JSON/rate-limit constants.
register-ts-node-esm.mjs Adds a Node --import hook to register ts-node/esm for running TS entrypoints under ESM.
package.json Sets "type": "module", adds build/lint/format/test scripts, pins Node engine to 24, and updates dev tooling deps.
jest.config.cjs Adds Jest configuration for ESM + ts-jest + .js specifier mapping.
eslint.config.mjs Replaces legacy ESLint config with ESLint 9 flat config aligned to service tooling.
.prettierrc Adds repo Prettier settings (single quotes, 120 print width).
.prettierignore Avoids formatting churn on pre-existing scripts and legacy docs/configs.
.npmrc Enables engine-strict to enforce the Node 24 engine constraint.
.gitignore Adds local conversion-notes doc to ignore list.
.eslintrc.json Removes legacy ESLint config in favor of flat config.
.editorconfig Adds baseline editor formatting rules aligned with new tooling.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@bickelj

bickelj commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator

There is a raft of dependency updates pending, and I suspected those could be more easily merged/adapted if we changed this project to ESM, maybe that was incorrect, but that was also part of the impetus.

@bickelj bickelj left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're missing some newlines, GLM.

Comment thread .editorconfig Outdated
Comment thread .npmrc Outdated
Comment thread .prettierignore Outdated
The data-scripts predate the shared, stricter tooling the service
repository standardizes on, so this brings them in line so both
repos lint, format, type-check, and test the same way: the flat
ESLint 9 config on `eslint-config-love`, Prettier, the split
build/type-check tsconfig, Jest in ESM mode, the Node 24 `engines`
plus `.npmrc`, and the lockfile bumped to v3. The pre-existing
scripts predate that strictness, so the rules that would force
large ESM-unrelated refactors of them are disabled and those files
are Prettier-ignored to keep the diff clean; only the small
refactors the kept rules require (`node:` prefixes, named
constants, `type`-only specifiers) are applied, with unit tests for
`ein` and `csv` covering the parsing the ESM switch touched.

Generated-by: GLM-5.2

@bickelj bickelj left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there are two things to do here:

  1. Address the review feedback regarding removal of an md file and renaming another file, do this as amendments to the existing commit(s).
  2. A new third commit on this branch that enables the linting rules that the service repository enforces, along with all the updates needed to the code to pass those rules.

Comment thread .gitignore
!config.example.json

# Conversion notes (local working doc, not for the repo)
CONVERT_CJS_TO_ESM.md

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excluding this one-off local file from everyone's repo is unnecessary and should be removed.

Comment thread .prettierignore
standalone/

# Conversion notes (untracked working doc):
CONVERT_CJS_TO_ESM.md

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excluding this one-off local file from everyone's repo is unnecessary and should be removed. (I removed it locally too)

Comment thread .prettierignore
# overrides in eslint.config.mjs. New code (unit tests) and config files remain
# prettier-enforced.
# Authored by GLM-5.2.
src/candid.ts

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a big ask, but I think you should leave this as-is in this commit, but go ahead and make a new third commit where these are removed, and in this new third commit the rules in eslint.config.mjs are enabled to match the rules in the service repository, and then all the code that needs to be adjusted to follow the rules also should be updated in this third commit.

Comment thread eslint.config.mjs
// simplification, and the await-in-loop directive pair). Those refactors are
// unrelated to the CommonJS->ESM conversion and would inject large, noisy
// diffs (and pollute future `git blame`), so they are deferred to the same
// separate follow-up rather than performed in this conversion commit. The

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my other comment, please do make the third follow-up commit described here.

Comment thread package.json
"lint:eslint": "eslint ./src --max-warnings=0",
"lint:prettier": "prettier . --check",
"lint:tsc": "tsc --noEmit -p tsconfig.dev.json",
"start": "node --import ./register-ts-node-esm.mjs src/index.ts",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before making the third commit mentioned elsewhere, can you please amend this commit to rename register-ts-node-esm.mjs to a more concise filename without losing much clarity? It seems like a mouthful to repeat here in the package.json on every command that needs it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants