Use commonjs package type for JS client (#36)

After many hours of research, this appears to be the most versatile and interoperable way of publishing dual package libraries.
solana-program · May 2, 2024 · 900ed38 · 900ed38
1 parent 41d47d0
commit 900ed38
Show file tree

Hide file tree

Showing 9 changed files with 48 additions and 36 deletions.
diff --git a/.changeset/clever-wombats-grin.md b/.changeset/clever-wombats-grin.md
@@ -0,0 +1,5 @@
+---
+"create-solana-program": patch
+---
+
+Use commonjs package type for JS client
diff --git a/template/clients/js/clients/js/_.eslintrc.cjs b/template/clients/js/clients/js/_.eslintrc.cjs
@@ -1,5 +1,11 @@
 module.exports = {
   extends: ['@solana/eslint-config-solana'],
+  ignorePatterns: ['.eslintrc.cjs', 'tsup.config.ts', 'env-shim.ts'],
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir: __dirname,
+    sourceType: 'module',
+  },
   rules: {
     '@typescript-eslint/ban-types': 'off',
     '@typescript-eslint/sort-type-constituents': 'off',

diff --git a/template/clients/js/clients/js/package.json.njk b/template/clients/js/clients/js/package.json.njk
@@ -3,15 +3,15 @@
   "version": "0.0.0",
   "description": "JavaScript client for the {{ programName | titleCase }} program",
   "sideEffects": false,
-  "module": "./dist/src/index.js",
-  "main": "./dist/src/index.cjs",
-  "types": "./dist/types/src/index.d.ts",
-  "type": "module",
+  "module": "./dist/src/index.mjs",
+  "main": "./dist/src/index.js",
+  "types": "./dist/types/index.d.ts",
+  "type": "commonjs",
   "exports": {
     ".": {
-      "types": "./dist/types/src/index.d.ts",
-      "import": "./dist/src/index.js",
-      "require": "./dist/src/index.cjs"
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/src/index.mjs",
+      "require": "./dist/src/index.js"
     }
   },
   "files": [

diff --git a/template/clients/js/clients/js/test/_setup.ts b/template/clients/js/clients/js/test/_setup.ts
@@ -23,7 +23,7 @@ import {
   setTransactionMessageLifetimeUsingBlockhash,
   signTransactionMessageWithSigners,
 } from '@solana/web3.js';
-import { findCounterPda, getCreateInstructionAsync } from '../src/index.js';
+import { findCounterPda, getCreateInstructionAsync } from '../src';
 
 type Client = {
   rpc: Rpc<SolanaRpcApi>;

diff --git a/template/clients/js/clients/js/test/create.test.ts b/template/clients/js/clients/js/test/create.test.ts
@@ -8,13 +8,13 @@ import {
   Counter,
   fetchCounterFromSeeds,
   getCreateInstructionAsync,
-} from '../src/index.js';
+} from '../src';
 import {
   createDefaultSolanaClient,
   createDefaultTransaction,
   generateKeyPairSignerWithSol,
   signAndSendTransaction,
-} from './_setup.js';
+} from './_setup';
 
 test('it creates a new counter account', async (t) => {
   // Given an authority key pair with some SOL.

diff --git a/template/clients/js/clients/js/test/increment.test.ts.njk b/template/clients/js/clients/js/test/increment.test.ts.njk
@@ -15,15 +15,15 @@ import {
   findCounterPda,
   getIncrementInstruction,
   getIncrementInstructionAsync,
-} from '../src/index.js';
+} from '../src';
 import {
   createCounterForAuthority,
   createDefaultSolanaClient,
   createDefaultTransaction,
   generateKeyPairSignerWithSol,
   getBalance,
   signAndSendTransaction,
-} from './_setup.js';
+} from './_setup';
 
 test('it increments an existing counter by 1 by default', async (t) => {
   // Given an authority key pair with an associated counter account of value 0.

diff --git a/template/clients/js/clients/js/tsconfig.declarations.json b/template/clients/js/clients/js/tsconfig.declarations.json
@@ -1,9 +1,10 @@
 {
   "compilerOptions": {
-      "declaration": true,
-      "declarationMap": true,
-      "emitDeclarationOnly": true,
-      "outDir": "./dist/types",
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true,
+    "outDir": "./dist/types",
   },
-  "extends": "./tsconfig.json"
+  "extends": "./tsconfig.json",
+  "include": ["src"]
 }
diff --git a/template/clients/js/clients/js/tsconfig.json b/template/clients/js/clients/js/tsconfig.json
@@ -1,23 +1,23 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
   "compilerOptions": {
-      "composite": false,
-      "declaration": true,
-      "declarationMap": true,
-      "esModuleInterop": true,
-      "forceConsistentCasingInFileNames": true,
-      "inlineSources": false,
-      "isolatedModules": true,
-      "module": "ESNext",
-      "moduleResolution": "node",
-      "noFallthroughCasesInSwitch": true,
-      "noUnusedLocals": true,
-      "noUnusedParameters": true,
-      "outDir": "./dist",
-      "preserveWatchOutput": true,
-      "skipLibCheck": true,
-      "strict": true,
-      "target": "ESNext"
+    "composite": false,
+    "declaration": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "inlineSources": false,
+    "isolatedModules": true,
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "noFallthroughCasesInSwitch": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "outDir": "./dist",
+    "preserveWatchOutput": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "target": "ESNext"
   },
   "exclude": ["node_modules"],
   "include": ["src", "test"]

diff --git a/template/clients/js/clients/js/tsup.config.ts b/template/clients/js/clients/js/tsup.config.ts
@@ -7,7 +7,7 @@ const SHARED_OPTIONS: Options = {
   entry: ['./src/index.ts'],
   inject: [path.resolve(__dirname, 'env-shim.ts')],
   outDir: './dist/src',
-  outExtension: ({ format }) => ({ js: format === 'cjs' ? '.cjs' : '.js' }),
+  outExtension: ({ format }) => ({ js: format === 'cjs' ? '.js' : '.mjs' }),
   sourcemap: true,
   treeshake: true,
 };
@@ -22,7 +22,7 @@ export default defineConfig(() => [
     ...SHARED_OPTIONS,
     bundle: false,
     entry: ['./test/*.ts'],
-    format: 'esm',
+    format: 'cjs',
     outDir: './dist/test',
   },
 ]);