Add script to prepare cli version

Author: eddeee888

.github/workflows/main.yml

@@ -79,6 +79,8 @@ jobs:
         run: |
           pnpm run dev-test:generate:${{matrix.method}}
           git diff --exit-code -- dev-test/
+      - name: Test CLI version ${{matrix.method}}
+        run: pnpm run dev-test:test-cli-version:${{matrix.method}}
 
   examples-tests:
     name: Examples - Normal

.gitignore

@@ -21,3 +21,6 @@ website/public/_redirects
 
 **/cypress/screenshots
 **/cypress/videos
+
+# Generated file for `graphql-codegen --version` to work. See `pnpm prepare-cli-version`.
+packages/graphql-codegen-cli/src/_version.ts

dev-test/general/package.json

@@ -7,6 +7,8 @@
     "generate": "pnpm generate:esm",
     "generate:cjs": "node ../../packages/graphql-codegen-cli/dist/cjs/bin.js --require dotenv/config --config codegen.ts dotenv_config_path=.env",
     "generate:esm": "node ../../packages/graphql-codegen-cli/dist/esm/bin.js --require dotenv/config --config codegen.ts dotenv_config_path=.env",
+    "test-cli-version:cjs": "node ../../packages/graphql-codegen-cli/dist/cjs/bin.js --version",
+    "test-cli-version:esm": "node ../../packages/graphql-codegen-cli/dist/esm/bin.js --version",
     "watch": "pnpm watch:esm",
     "watch:cjs": "pnpm generate:cjs --watch",
     "watch:esm": "pnpm generate:esm --watch"

package.json

@@ -7,13 +7,15 @@
     "node": ">= 16.0.0"
   },
   "scripts": {
-    "prebuild": "rimraf dist/ .bob/ tsconfig.tsbuildinfo",
+    "prebuild": "rimraf dist/ .bob/ tsconfig.tsbuildinfo && pnpm prepare-cli-version",
     "build": "bob build",
     "postbuild": "pnpm fix-bins",
     "clean": "rimraf node_modules/",
     "dev-test:generate": "pnpm --filter=\"dev-test*\" generate",
     "dev-test:generate:cjs": "pnpm --filter=\"dev-test*\" generate:cjs",
     "dev-test:generate:esm": "pnpm --filter=\"dev-test*\" generate:esm",
+    "dev-test:test-cli-version:cjs": "pnpm prepare-cli-version && pnpm --filter=\"dev-test-general\" test-cli-version:cjs",
+    "dev-test:test-cli-version:esm": "pnpm prepare-cli-version && pnpm --filter=\"dev-test-general\" test-cli-version:esm",
     "dev-test:watch": "pnpm --filter=\"dev-test*\" watch",
     "dev-test:watch:cjs": "pnpm --filter=\"dev-test*\" watch:cjs",
     "dev-test:watch:esm": "pnpm --filter=\"dev-test*\" watch:esm",
@@ -24,6 +26,7 @@
     "postinstall": "husky install",
     "lint": "eslint --cache .",
     "lint:ci": "eslint --cache --output-file eslint_report.json --format json .",
+    "prepare-cli-version": "node ./scripts/prepare-cli-version.mjs",
     "prettier": "prettier --cache --write --list-different .",
     "prettier:check": "prettier --cache --check .",
     "rebuild": "bob build --incremental",

packages/graphql-codegen-cli/src/config.ts

@@ -17,6 +17,7 @@ import {
   Types,
 } from '@graphql-codegen/plugin-helpers';
 import type { UnnormalizedTypeDefPointer } from '@graphql-tools/load';
+import { version } from './_version.js'; // Run `pnpm prepare-cli-version` to initialize this value
 import { findAndLoadGraphQLConfig } from './graphql-config.js';
 import {
   defaultDocumentsLoadOptions,
@@ -283,7 +284,7 @@ export function buildOptions() {
 }
 
 export function parseArgv(argv = process.argv): YamlCliFlags {
-  return yargs(argv).options(buildOptions()).parse(argv) as any;
+  return yargs(argv).version(version).options(buildOptions()).parse(argv) as any;
 }
 
 export async function createContext(

scripts/prepare-cli-version.mjs

@@ -0,0 +1,23 @@
+import * as fs from 'fs';
+import packageJson from '../packages/graphql-codegen-cli/package.json' with { type: 'json' };
+
+/**
+ * This script extracts the `@graphql-codegen/cli` version ahead of build and publish time,
+ * so at runtime, we don't have to import `package.json` file for the package version.
+ *
+ * Importing a `.json` file is surprisingly hard for a dual ESM/CJS package.
+ * The current approach is the simplest.
+ *
+ * Many alternatives considered:
+ * 1. `import {} from '../package.json'` does not work in ESM without import attributes i.e. `with { type: 'json' }`.
+ * 2. `createRequire` from `node:module` needs `import.meta.url` which works for ESM, but doesn't work for CJS because it is a syntax error at parse-time.
+ * 3. `fs.readFile` reads from `cwd`, which means we need to use `__dirname` or `import.meta.url` as the starting point. `import.meta.url` is a syntax error at parse-time for CJS.
+ * 4. Create a shim `.mts` file and dynamically import it at runtime for ESM
+ * 5. Use `nodenext` instead of `esnext` for `module` and `moduleResolution`. Maybe a big change?
+ * 6. Ship ESM-only. This is a big change.
+ */
+fs.writeFileSync(
+  './packages/graphql-codegen-cli/src/_version.ts',
+  `export const version = '${packageJson.version}';`,
+  'utf8',
+);