-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create version 1.0.1 for public release (#3)
Context: The initial 1.0.0 release revealed some problems in the build process: - The `dist` directory included two copies of the source code; one directly inside `dist/` and the other in `dist/src`. - The `dist` directory mistakenly included the `test` directory. - When installed as a package, the code in `node_modules` could not be navigated using TypeScript-enabled editor features because there was no `tsconfig.json` in the root directory. Changes: The installed package is now structured as follows: - `dist/`: Contains a compiled JavaScript version of the package's `src` directory, along with type definitions and mappings. - `src/`: Contains the original TypeScript source code. - `LICENSE.md` - `package.json` - `README.md` - `tsconfig.build.json`: Included to help document the built package. - `tsconfig.json`: Included so that editors can navigate the TypeScript source code, since most imports use path aliases. This new structure solves the issues outlined in the Context section.
- Loading branch information
Showing
6 changed files
with
11 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,2 @@ | ||
dist/ | ||
node_modules/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,5 +4,3 @@ | |
.prettierrc.js | ||
jest.config.ts | ||
test/ | ||
tsconfig.build.json | ||
tsconfig.json |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,21 @@ | ||
{ | ||
"compilerOptions": { | ||
"alwaysStrict": true, | ||
"baseUrl": ".", | ||
"rootDir": "./src", | ||
"baseUrl": "./src", | ||
"declaration": true, | ||
"declarationMap": true, | ||
"esModuleInterop": true, | ||
"module": "commonjs", | ||
"noErrorTruncation": true, | ||
"outDir": "./dist", | ||
"paths": { | ||
"@": ["src/index"], | ||
"@/*": ["src/*"] | ||
"@": ["./index"], | ||
"@/*": ["./*"] | ||
}, | ||
"sourceMap": true, | ||
"strict": true, | ||
"target": "ES2019" | ||
}, | ||
"exclude": ["node_modules", "test"], | ||
"include": ["src"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters