Skip to content

Commit 6b76976

Browse files
IgnatGIgnatG
committed
feat: added CJS compatibility
1 parent 8a4ac14 commit 6b76976

File tree

5 files changed

+26
-60
lines changed

5 files changed

+26
-60
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -102,3 +102,5 @@ dist
102102

103103
# TernJS port file
104104
.tern-port
105+
106+
lib/

‎README.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## Example TypeScript Package ready to be published to NPM
2+
3+
This is an example TypeScript Package ready to be published to NPM. It has been set up with automated tests and package publishing workflow using GitHub Actions CI/CD.
4+
This package could serve as a starter/boilerplate/demo them.

‎package.json

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
{
22
"name": "@uk-export-finance/typescript-package",
3-
"version": "1.0.3",
4-
"description": "TypeScript Package ready to be published on NPM and Github packages",
5-
"main": "dist/index.js",
3+
"version": "1.0.0",
4+
"description": "TypeScript Package ready to be published to NPM",
5+
"main": "./lib/cjs/index.js",
6+
"module": "./lib/esm/index.js",
67
"scripts": {
8+
"build": "tsc -p tsconfig.json && tsc -p tsconfig-cjs.json",
79
"postinstall": "husky install",
8-
"prepublishOnly": "pinst --disable",
910
"postpublish": "pinst --enable",
10-
"build": "tsc",
11+
"prepublishOnly": "pinst --disable && npm run build",
1112
"lint": "eslint --ext .ts src/",
1213
"lint:fix": "eslint --ext .ts src/ --fix",
1314
"prepare": "husky install"
@@ -16,9 +17,9 @@
1617
"access": "public"
1718
},
1819
"files": [
19-
"dist"
20+
"lib"
2021
],
21-
"keywords": [],
22+
"keywords": ["npm", "boilerplate", "typescript", "boilerplate-template", "npm-package", "starter-template", "typescript-boilerplate", "typescript-starter", "typescript-template-project"],
2223
"author": "Gabriel Ignat",
2324
"license": "MIT",
2425
"homepage": "https://github.com/UK-Export-Finance/typescript-package",

‎tsconfig-cjs.json

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"extends": "./tsconfig.json",
3+
"compilerOptions": {
4+
"module": "CommonJS",
5+
"outDir": "./lib/cjs"
6+
},
7+
}

‎tsconfig.json

+5-53
Original file line numberDiff line numberDiff line change
@@ -3,70 +3,22 @@
33
/* Visit https://aka.ms/tsconfig.json to read more about this file */
44

55
/* Basic Options */
6-
// "incremental": true, /* Enable incremental compilation */
7-
"target": "ES2020" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */,
8-
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
9-
// "lib": [], /* Specify library files to be included in the compilation. */
10-
// "allowJs": true, /* Allow javascript files to be compiled. */
11-
// "checkJs": true, /* Report errors in .js files. */
12-
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
6+
"target": "ESNEXT" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */,
7+
"module": "ESNext", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
138
"declaration": true, /* Generates corresponding '.d.ts' file. */
14-
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
15-
// "sourceMap": true, /* Generates corresponding '.map' file. */
16-
// "outFile": "./", /* Concatenate and emit output to single file. */
17-
"outDir": "dist", /* Redirect output structure to the directory. */
18-
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
19-
// "composite": true, /* Enable project compilation */
20-
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
21-
// "removeComments": true, /* Do not emit comments to output. */
22-
// "noEmit": true, /* Do not emit outputs. */
23-
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
24-
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
25-
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
9+
"outDir": "./lib/esm", /* Redirect output structure to the directory. */
2610

2711
/* Strict Type-Checking Options */
28-
"strict": true /* Enable all strict type-checking options. */,
29-
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
30-
// "strictNullChecks": true, /* Enable strict null checks. */
31-
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
32-
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
33-
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
34-
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
35-
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
36-
37-
/* Additional Checks */
38-
// "noUnusedLocals": true, /* Report errors on unused locals. */
39-
// "noUnusedParameters": true, /* Report errors on unused parameters. */
40-
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
41-
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
12+
"strict": true /* Enable all strict type-checking options. */,
4213

4314
/* Module Resolution Options */
4415
"moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
45-
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
46-
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
47-
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
48-
// "typeRoots": [], /* List of folders to include type definitions from. */
49-
// "types": [], /* Type declaration files to be included in compilation. */
50-
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
51-
// "resolveJsonModule": true,
5216
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
53-
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
54-
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
55-
56-
/* Source Map Options */
57-
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
58-
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
59-
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
60-
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
6117

6218
/* Experimental Options */
6319
"experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
64-
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
65-
66-
/* Advanced Options */
67-
// "skipLibCheck": true, /* Skip type checking of declaration files. */
6820
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
6921
},
70-
"include": ["src/**/*"],
22+
"include": ["src/"],
7123
"exclude": ["node_modules"]
7224
}

0 commit comments

Comments
 (0)