Skip to content

Commit 802e94c

Browse files
afrojezusfrodeaa
andauthored
fix(module): Provide ESM and CJS artifacts (#82)
Allow library to be used with older runtimes (down to ES3) and newer runtimes (ESM) for largest coverage of build systems Resolves #81 * fix(module): make use of exports, avoid hacky build behaviour * Update tsconfig.cjs.json --------- Co-authored-by: Frode Aannevik <[email protected]>
1 parent 7fd9283 commit 802e94c

8 files changed

+1284
-1432
lines changed

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,7 @@
22
.vscode/
33
node_modules/
44
yarn-error.log
5+
lib/
56
dist/
7+
.DS_Store
8+
*.tgz

.npmignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
node_modules/

package.json

+19-5
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,24 @@
22
"name": "@dintero/email-chk",
33
"version": "0.0.0-development",
44
"description": "",
5-
"main": "dist/index.js",
6-
"types": "dist/index.d.ts",
5+
"exports": {
6+
".": {
7+
"types": "./lib/types/index.d.ts",
8+
"import": "./lib/esm/index.js",
9+
"require": "./lib/cjs/index.js",
10+
"default": "./lib/esm/index.js"
11+
},
12+
"./package.json": "./package.json"
13+
},
14+
"main": "lib/cjs/index.js",
15+
"types": "lib/types/index.d.ts",
716
"author": "Thoralf Thelle <[email protected]>",
817
"license": "MIT",
918
"private": false,
10-
"files": ["/dist"],
19+
"files": [
20+
"lib"
21+
],
22+
"sideEffects": "false",
1123
"jest": {
1224
"preset": "ts-jest",
1325
"testEnvironment": "node",
@@ -37,9 +49,11 @@
3749
},
3850
"scripts": {
3951
"test": "jest",
40-
"clean": "rm -rf dist",
52+
"clean": "rm -rf ./lib",
4153
"check": "yarn run lint && yarn run test",
42-
"build": "tsc -p tsconfig.build.json",
54+
"build": "yarn run clean && yarn run build:esm && yarn run build:cjs",
55+
"build:esm": "tsc -p ./tsconfig.esm.json",
56+
"build:cjs": "tsc -p ./tsconfig.cjs.json",
4357
"lint": "eslint ./src",
4458
"release": "semantic-release",
4559
"prepublishOnly": "yarn run build"

tsconfig.build.json

-6
This file was deleted.

tsconfig.cjs.json

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"extends": "./tsconfig.json",
3+
"compilerOptions": {
4+
"target": "ES3",
5+
"module": "CommonJS",
6+
"outDir": "./lib/cjs",
7+
},
8+
"exclude": [
9+
"src/__tests__"
10+
]
11+
}

tsconfig.esm.json

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"extends": "./tsconfig.json",
3+
"compilerOptions": {
4+
"target": "ESNext",
5+
"module": "ESNext",
6+
"outDir": "./lib/esm",
7+
"moduleResolution": "NodeNext"
8+
},
9+
"exclude": [
10+
"src/__tests__"
11+
]
12+
}

tsconfig.json

+21-96
Original file line numberDiff line numberDiff line change
@@ -1,106 +1,31 @@
11
{
22
"compilerOptions": {
3-
/* Visit https://aka.ms/tsconfig to read more about this file */
4-
5-
/* Projects */
6-
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
7-
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
8-
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
9-
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
10-
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
11-
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
12-
13-
/* Language and Environment */
14-
"target": "ESNext", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
15-
"lib": ["ESNext", "DOM"], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
16-
// "jsx": "preserve", /* Specify what JSX code is generated. */
17-
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
18-
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
19-
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
20-
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
21-
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
22-
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
23-
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
24-
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
25-
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
26-
27-
/* Modules */
28-
"module": "commonjs", /* Specify what module code is generated. */
29-
// "rootDir": "./", /* Specify the root folder within your source files. */
30-
// "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
31-
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
32-
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
33-
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
34-
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
35-
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
36-
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
37-
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
38-
// "resolveJsonModule": true, /* Enable importing .json files. */
39-
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
40-
41-
/* JavaScript Support */
42-
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
43-
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
44-
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
3+
"target": "ESNext",
4+
"lib": ["ESNext", "DOM"],
455

466
/* Emit */
47-
"declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
48-
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
49-
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
50-
"sourceMap": true, /* Create source map files for emitted JavaScript files. */
51-
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
52-
"outDir": "./dist", /* Specify an output folder for all emitted files. */
53-
// "removeComments": true, /* Disable emitting comments. */
54-
// "noEmit": true, /* Disable emitting files from a compilation. */
55-
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
56-
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
57-
"downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
58-
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
59-
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
60-
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
61-
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
62-
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
63-
// "newLine": "crlf", /* Set the newline character for emitting files. */
64-
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
65-
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
66-
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
67-
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
68-
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
69-
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
7+
"declaration": true,
8+
"inlineSourceMap": true,
9+
"downlevelIteration": true,
10+
"declarationDir": "./lib/types",
7011

7112
/* Interop Constraints */
72-
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
73-
"allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
74-
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
75-
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
76-
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
13+
"allowSyntheticDefaultImports": true,
14+
"esModuleInterop": true,
15+
"forceConsistentCasingInFileNames": true,
7716

7817
/* Type Checking */
79-
"strict": true, /* Enable all strict type-checking options. */
80-
"noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
81-
"strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
82-
"strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
83-
"strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
84-
"strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
85-
"noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
86-
"useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
87-
"alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
88-
"noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
89-
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
90-
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
91-
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
92-
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
93-
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
94-
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
95-
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
96-
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
97-
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
98-
99-
/* Completeness */
100-
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
101-
"skipLibCheck": true /* Skip type checking all .d.ts files. */
18+
"strict": true,
19+
"noImplicitAny": true,
20+
"strictNullChecks": true,
21+
"strictFunctionTypes": true,
22+
"strictBindCallApply": true,
23+
"strictPropertyInitialization": true,
24+
"noImplicitThis": true,
25+
"useUnknownInCatchVariables": true,
26+
"alwaysStrict": true,
27+
"noUnusedLocals": true,
28+
"skipLibCheck": true
10229
},
103-
"include": [
104-
"src"
105-
]
30+
"include": ["src"]
10631
}

0 commit comments

Comments
 (0)