Skip to content

Attempting to fix issue with ESM build output #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jabez007 wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Attempting to fix issue with ESM build output #2

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f7ce7f7
updating bin script to fix ESM builds
jabez007 Jun 6, 2025
6f3bea7
update tsconfig to better align with produced projects
jabez007 Jun 6, 2025
473650b
minor fixes from code review
jabez007 Jun 6, 2025
f3c3d72
update actions versions
jabez007 Jun 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
674 changes: 674 additions & 0 deletions LICENSE
View file
Open in desktop

Large diffs are not rendered by default.

104 changes: 64 additions & 40 deletions bin/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,62 +57,58 @@ async function main() {
);
configUpdates = [
{
key: 'declaration',
value: true,
key: 'target',
value: '"ES2019"',
},
{
key: 'declarationMap',
value: true,
key: 'module',
value: '"Node18"',
},
{
key: 'sourceMap',
value: true,
key: 'rootDir',
value: '"./src"',
},
{
key: 'module',
value: '"NodeNext"',
{
key: 'moduleResolution',
value: '"Node16"',
},
{
key: 'target',
value: '"ES2017"',
key: 'baseUrl',
value: '"."',
},
{
key: 'moduleResolution',
value: '"Node16"',
key: 'paths',
value: JSON.stringify({
'@/*': ['src/*'],
'@utils/*': ['src/utils/*'],
}),
},
{
key: 'esModuleInterop',
key: 'rewriteRelativeImportExtensions',
value: true,
},
},
{
key: 'skipLibCheck',
key: 'declaration',
value: true,
},
{
key: 'resolveJsonModule',
key: 'sourceMap',
value: true,
},
{
key: 'outDir',
value: '"./dist"',
},
{
key: 'rootDir',
value: '"./src"',
},
{
key: 'baseUrl',
value: '"."',
key: 'removeComments',
value: false,
},
{
key: 'paths',
value: JSON.stringify({
'@/*': ['src/*'],
'@utils/*': ['src/utils/*'],
}),
key: 'esModuleInterop',
value: true,
},
{
key: 'removeComments',
key: 'skipLibCheck',
value: true,
},
];
Expand All @@ -134,7 +130,7 @@ async function main() {
`},
"include": ["src/**/*"],
"exclude": [
"node_module",
"node_modules",
"dist",
"tests"
]
Expand All @@ -151,11 +147,11 @@ async function main() {
compilerOptions: {
module: 'CommonJS',
moduleResolution: 'Node10',
target: 'ES5',
outDir: './dist/cjs',
declarationDir: './dist/cjs',
target: 'ES2015',
declaration: false,
declarationMap: false,
},
include: ['src/**/*'],
},
null,
2
Expand All @@ -169,11 +165,31 @@ async function main() {
{
extends: './tsconfig.json',
compilerOptions: {
module: 'NodeNext',
moduleResolution: 'NodeNext',
target: 'ES2023',
outDir: './dist/esm',
declarationDir: './dist/esm',
target: 'ES2020',
},
include: ['src/**/*'],
declaration: false,
declarationMap: false,
},
},
null,
2
)
);

console.log('writing tsconfig for Types');
await write(
join(projectWorkingDirectory, 'tsconfig.types.json'),
JSON.stringify(
{
extends: './tsconfig.json',
compilerOptions: {
outDir: './dist/types',
emitDeclarationOnly: true,
declaration: true,
declarationMap: true,
},
},
null,
2
Expand All @@ -195,14 +211,18 @@ async function main() {
await exec('npm pkg set main=./dist/cjs/index.js');

console.log('adding types to package.json');
await exec('npm pkg set types=./dist/cjs/index.d.ts');
await exec('npm pkg set types=./dist/types/index.d.ts');

console.log('adding module to package.json');
await exec('npm pkg set module=./dist/esm/index.js');

console.log('setting type in package.json');
await exec('npm pkg set type=module');

console.log('adding exports in package.json');
await exec('npm pkg set exports["."].import=./dist/esm/index.js');
await exec('npm pkg set exports["."].require=./dist/cjs/index.js');
await exec('npm pkg set exports["."].types=./dist/types/index.js');
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated

console.log('adding files in package.json');
await exec('npm pkg set files[0]=dist/**/*');
Expand All @@ -216,6 +236,7 @@ async function main() {
await exec(
'npm pkg set scripts.build="npm run build:cjs && npm run build:esm"'
);
await exec('npm pkg set scripts.build:types="tsc --project tsconfig.types.json"');

console.log('adding prepublishOnly script');
await exec('npm pkg set scripts.prepublishOnly="npm run build"');
Expand All @@ -227,7 +248,10 @@ async function main() {

console.log('adding prebuild script');
await exec('npm pkg set scripts.prebuild="npm run clean"');
/* END */

console.log('adding postbuild script');
await exec('npm pkg set scripts.prebuild="npm run build:types"');
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated
/* END */

/*
* install tsc-alias
Expand Down Expand Up @@ -324,7 +348,7 @@ async function main() {
extends: './tsconfig.json',
compilerOptions: {
module: 'CommonJS',
target: 'ES2020',
target: 'ES2017',
outDir: './dist/test',
rootDir: './',
noEmit: false,
Expand Down
15 changes: 8 additions & 7 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 8 additions & 5 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@mccann-hub/create-typescript-template",
"version": "0.3.0",
"version": "0.4.0",
"publishConfig": {
"access": "public"
},
Expand All @@ -11,10 +11,12 @@
"test": "cross-env TSX_TSCONFIG_PATH='./tsconfig.test.json' mocha",
"build:cjs": "tsc --project tsconfig.commonjs.json && tsc-alias -p tsconfig.commonjs.json",
"build:esm": "tsc --project tsconfig.esm.json && tsc-alias -p tsconfig.esm.json",
"build:types": "tsc --project tsconfig.types.json",
"build": "npm run build:cjs && npm run build:esm",
"prepublishOnly": "npm run build",
"clean": "node -e \"require('fs').rmSync('./dist', { recursive: true, force: true })\"",
"prebuild": "npm run clean",
"postbuild": "npm run build:types",
"lint": "eslint . --ext .ts,.js --fix"
},
"keywords": [
Expand All @@ -37,7 +39,7 @@
"npm-publish"
],
"author": "jabez007",
"license": "ISC",
"license": "GPL-3.0-only",
"devDependencies": {
"@types/mocha": "^10.0.9",
"@types/node": "^22.8.2",
Expand All @@ -49,14 +51,15 @@
"tsc-alias": "^1.8.10",
"tsconfig-paths": "^4.2.0",
"tsx": "^4.19.2",
"typescript": "^5.6.3"
"typescript": "^5.8.3"
},
"types": "./dist/cjs/index.d.ts",
"types": "./dist/types/index.d.ts",
"module": "./dist/esm/index.js",
"exports": {
".": {
"import": "./dist/esm/index.js",
"require": "./dist/cjs/index.js"
"require": "./dist/cjs/index.js",
"types": "./dist/types/index.d.ts"
}
},
"repository": {
Expand Down
12 changes: 5 additions & 7 deletions tsconfig.commonjs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,9 @@
"compilerOptions": {
"module": "CommonJS",
"moduleResolution": "Node10",
"target": "ES5",
"outDir": "./dist/cjs",
"declarationDir": "./dist/cjs",
"target": "ES2015"
},
"include": [
"src/**/*"
]
}
"declaration": false,
"declarationMap": false
}
}
14 changes: 7 additions & 7 deletions tsconfig.esm.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"module": "nodenext",
"moduleResolution": "nodenext",
"target": "ES2023",
"outDir": "./dist/esm",
"declarationDir": "./dist/esm",
"target": "ES2020"
},
"include": [
"src/**/*"
]
}
"declaration": false,
"declarationMap": false
}
}
Loading