Skip to content

Commit ae1d40d

Browse files
committed
Project setup
1 parent 4557e4b commit ae1d40d

7 files changed

Lines changed: 16 additions & 159 deletions

File tree

.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
APP_TITLE="typescript-template"
1+
APP_TITLE="typescript-template-library"

CHANGELOG.md

Lines changed: 1 addition & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -1,123 +1 @@
1-
# typescript-template
2-
3-
## [2.2.0]
4-
5-
### Additions
6-
- [TSTEMPLATE-38] Global error handler should log error .toString() for additional information
7-
- [TSTEMPLATE-35] Add vscode default build & debug tasks
8-
- [TSTEMPLATE-34] Add a test:prod script, so that the build doesn't run twice when using ts-packager
9-
10-
### Fixes
11-
- [TSTEMPLATE-37] npm start / npm run dev can skip the lint
12-
- [TSTEMPLATE-36] Update instructions to use git pull instead of bitbucket fork
13-
14-
## [2.1.0]
15-
16-
### Additions
17-
- [TSTEMPLATE-33] Add teardown function for graceful shutdown
18-
19-
### Fixes
20-
21-
## [2.0.1]
22-
23-
### Fixes
24-
- [TSTEMPLATE-31] As a user, I should be able to reuse bootstrap options from scripts
25-
- [TSTEMPLATE-30] Docs build is broken after upgrade of typedoc
26-
27-
## [v2.0.0]
28-
29-
### Breaking Changes
30-
- [TSTEMPLATE-28] Move test specs to test/spec
31-
- [TSTEMPLATE-25] Switch to ts-tiny-log
32-
- [TSTEMPLATE-21] Upgrade to node v16
33-
34-
### Additions
35-
- [TSTEMPLATE-27] Add script directory
36-
- [TSTEMPLATE-26] Setup nodemon watch
37-
- [TSTEMPLATE-24] Switch to ts-error-handler
38-
- [TSTEMPLATE-23] Switch to ts-async-bootstrap
39-
- [TSTEMPLATE-22] Switch from dotenv to ts-appconfig
40-
41-
### Fixes
42-
- [TSTEMPLATE-20] Normalize project names
43-
- [TSTEMPLATE-19] Add console warnings to dev lint settings, so that test logging doesn't stay until the end
44-
45-
## [v1.2.4]
46-
47-
### Fixes
48-
- [TSTEMPLATE-18] Add instructions in readme that MY_APP replacement should not contain spaces
49-
- [TSTEMPLATE-17] Environment file should merge declaration and definitions
50-
- [TSTEMPLATE-16] Build should clear dist
51-
- [TSTEMPLATE-15] Set no-empty eslint rule to warn instead of error
52-
- [TSTEMPLATE-14] Remove tsconfig.spec.json
53-
- [TSTEMPLATE-13] Switch tsconfig to output es6
54-
55-
## [v1.2.3]
56-
57-
### Fixes
58-
- npm update
59-
60-
## [v1.2.2]
61-
62-
### Fixes
63-
- [TSTEMPLATE-7] Source mapping references wrong line numbers when run in dev/ts-node
64-
- [TSTEMPLATE-8] Set stack trace limit to Infinity
65-
- [TSTEMPLATE-9] Filter stack traces for "just my code"
66-
- [TSTEMPLATE-10] Remove webpack from default build-chain
67-
- [TSTEMPLATE-11] Remove dist references from package.json
68-
- [TSTEMPLATE-12] Add lint rule for unresolved promises
69-
70-
## [v1.2.1]
71-
72-
### Fixes
73-
- [TSTEMPLATE-3][Docs] Typedoc --excludeNotExported switch is deprecated
74-
- [TSTEMPLATE-4] Seperate index.ts from main.ts
75-
- [TSTEMPLATE-5] Source mapping should be loaded before imports
76-
- [TSTEMPLATE-6] main() entrypoint should have catch block
77-
78-
## [v1.2.0]
79-
80-
### Additions
81-
82-
- Add nodemon support
83-
- Remove default pre&post process scripts
84-
- Add :clean scripts for rebuilding
85-
86-
## [v1.1.0] - Jan-13-2021
87-
88-
### Additions
89-
90-
- Updated documentation for easier installation
91-
- Add webpack build chain
92-
- Add source mapping
93-
94-
### Fixes
95-
96-
- Move `main.ts` to `index.ts` to better meet node standard & to allow loading by directory with implicit entrypoint
97-
- Max-line-length should be warning, not error
98-
- [TSTEMPLATE-2] Environment doesn't infer type of export 'env'
99-
100-
## [v1.0.0] - Oct-15-2020
101-
102-
### Breaking Changes
103-
104-
- Switched from tslint to eslint due to deprecation
105-
106-
### Additions
107-
108-
- Add `npm start` script
109-
- Add code coverage reporting and coveralls configuration
110-
- Add additional prod linting
111-
112-
### Fixes
113-
114-
- Cleanup prettier config
115-
- Added unit tests for untested code
116-
- Linting should automatically fix
117-
- Update readme code samples
118-
- Add ts-project-version to package.json for version control
119-
- Don't build on prepare hook
120-
121-
## [v0.0.0] - Oct-09-2020 - Initial Release
122-
123-
Initial Release
1+
# typescript-template-library

MIGRATION.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1 @@
1-
# TypeScript Template Migration Guide
2-
3-
## What version do you have?
4-
> Choose the version you have before upgrading, and follow the guide to the bottom from there.
5-
- [Version 1.x.x](#version-1.x.x-->-2.x.x)
6-
7-
## Version 1.x.x -> 2.x.x
8-
9-
### Node version has upgraded to version 16
10-
11-
You should take care of any deprecation notices and fix any compilation errors. You must also update your environments to use Node 16 or greater
12-
13-
### Test spec files (*.spec.ts) have moved from `test/` to `test/spec/`
14-
15-
If you have any test files, you should run the command `git mv test/*.spec.ts test/spec/`
16-
17-
### The `logger.ts` file has been replaced
18-
19-
If you are using the logger file, you have some options:
20-
21-
1. **Refuse This Change** - Restore the `src/logger.ts` file and delete `src/log.ts`. You will also have to update any references and tests
22-
2. **Use the new logger without updating references** - Rename `src/log.ts` to `src.logger.ts`, and change `export const log` to `export const logger`
23-
3. **Upgrade** - If you would like to use the new logger, and update your application to use it, you will have to replace all references to `import { logger } from './logger';` to `import { log } from './log';`.
1+
# TypeScript Template Library Migration Guide

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# typescript-template
1+
# typescript-template-library
22

33
## Installation
44

@@ -10,13 +10,13 @@
1010
```
1111
2. Install the template (Copy this into git bash).
1212
```bash
13-
git remote add template https://github.com/StatelessStudio/typescript-template/ && git pull template master --allow-unrelated-histories && git remote remove template
13+
git remote add template https://github.com/StatelessStudio/typescript-template-library/ && git pull template master --allow-unrelated-histories && git remote remove template
1414
```
15-
3. Replace "typescript-template" with the name of your app project-wide (**No Spaces or special characters except dash!**)
15+
3. Replace "typescript-template-library" with the name of your app project-wide (**No Spaces or special characters except dash!**)
1616
4. `npm i`
1717
5. Update the documentation, changelog, etc
1818

19-
## Pulling updates from typescript-template
19+
## Pulling updates from typescript-template-library
2020

2121
1. Run the install command in the installation instructions
2222
2. Resolve merge conflicts

package-lock.json

Lines changed: 3 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"name": "typescript-template",
2+
"name": "typescript-template-library",
33
"version": "1.0.0",
44
"ts-project-version": "2.2.0",
5-
"description": "typescript-template",
5+
"description": "typescript-template-library",
66
"scripts": {
77
"start": "npm run dev",
88
"dev": "ts-node src/index.ts",
@@ -48,14 +48,14 @@
4848
},
4949
"repository": {
5050
"type": "git",
51-
"url": "git+https://github.com/StatelessStudio/typescript-template.git"
51+
"url": "git+https://github.com/StatelessStudio/typescript-template-library.git"
5252
},
5353
"author": "stateless-studio",
5454
"license": "MIT",
5555
"bugs": {
56-
"url": "https://github.com/StatelessStudio/typescript-template/issues"
56+
"url": "https://github.com/StatelessStudio/typescript-template-library/issues"
5757
},
58-
"homepage": "https://github.com/StatelessStudio/typescript-template#readme",
58+
"homepage": "https://github.com/StatelessStudio/typescript-template-library#readme",
5959
"keywords": [
6060
]
6161
}

src/environment.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { AppConfig, configure } from 'ts-appconfig';
44
* Environment Variables Schema
55
*/
66
export class Environment extends AppConfig {
7-
readonly APP_TITLE = 'typescript-template';
7+
readonly APP_TITLE = 'typescript-template-library';
88
}
99

1010
/**

0 commit comments

Comments
 (0)