@asri/logger
Advanced tools
Comparing version 0.0.0-alpha.2 to 0.0.0-alpha.3
{ | ||
"name": "@asri/logger", | ||
"version": "0.0.0-alpha.2", | ||
"version": "0.0.0-alpha.3", | ||
"description": "A light-weight, performant, and consistent approach to logging.", | ||
@@ -9,7 +9,7 @@ "main": "./dist/index.js", | ||
"compile": "rm -rf ./dist && tsc", | ||
"format": "prettier format --write \"./{src,test}/**/*.ts\"", | ||
"format": "prettier --write \"./{src,test}/**/*.ts\"", | ||
"format:check": "prettier --check \"./{src,test}/**/*.ts\"", | ||
"test": "jest", | ||
"prepare": "npm run compile", | ||
"prepare": "npm run format:check && npm run compile", | ||
"prepublishOnly": "npm test", | ||
"version": "npm run format && git add -A ./src", | ||
"postversion": "git push && git push --tags" | ||
@@ -26,7 +26,7 @@ }, | ||
"pino", | ||
"node", | ||
"node.js", | ||
"javascript", | ||
"js", | ||
"typescript" | ||
"typescript", | ||
"node", | ||
"node.js" | ||
], | ||
@@ -44,3 +44,3 @@ "author": "Slavo Vojacek", | ||
"jest": "^25.1.0", | ||
"prettier": "1.19.1", | ||
"prettier": "2.0.2", | ||
"ts-jest": "^25.2.1", | ||
@@ -47,0 +47,0 @@ "typescript": "^3.8.3", |
@@ -15,5 +15,5 @@ **⚠️ WARNING: This project is currently under development.** | ||
- [Core design principles](#core-design-principles) | ||
- [TypeScript](#typescript) | ||
- [Why TypeScript?](#why-typescript) | ||
- [Technical excellence and agile ways of working](#technical-excellence-and-agile-ways-of-working) | ||
- [People & process](#people--process) | ||
- [Encourage Best Practices](#encourage-best-practices) | ||
- [Node version support](#node-version-support) | ||
@@ -67,4 +67,6 @@ - [Why ES2018?](#why-es2018) | ||
* **Reference implementation**; this collection of modules may serve as a reference implementation for our digital colleagues. It should therefore encourage best practices such as writing easy to understand code, testing, automation, documentation, semantic versioning (+ changelogs), up-to-date dependencies, and more. | ||
### Encourage Best Practices | ||
This collection of modules _may_ serve as a reference implementation for many of our colleagues. It should therefore encourage best practices such as writing easy to understand code, comprehensive testing, automation, documentation, semantic versioning (+ semantic commit messages, automatic changelogs, etc.), up-to-date dependencies, and more. | ||
## TypeScript | ||
@@ -79,10 +81,9 @@ | ||
* **Great tooling and overall developer experience.** Strong and thriving open-source community, backed by Microsoft. | ||
* **Increased productivity.** Type inference, intelligent code completion, and refactoring in confidence all contribute to increased productivity through minimising a specific class of bugs, reducing boilerplate, and maintaining a healthy codebase. | ||
* **A taste of future JavaScript, with _optional_ types.** Always up-to-date with upcoming ECMA features, compliant with proposals/specs. | ||
### People & process | ||
* **Helps attract and retain the best talent.** TypeScript consistently ranks as one of the most loved _and_ wanted languages in the annual StackOverflow developer surveys. | ||
* **Helps our clients attract and retain the best talent.** TypeScript consistently ranks as one of the most loved _and_ wanted languages in the annual StackOverflow developer surveys. | ||
* **Helps clients manage complex projects.** TODO add more text. | ||
You can read more about TypeScript in [the handbook](https://www.typescriptlang.org/docs/handbook/). | ||
@@ -116,5 +117,2 @@ | ||
* [ ] How do we use these modules at a client engagement? Find a way for the client to be able to build on this once our team phases out. The obvious solutions are forking and/or copy-pasting the source-code, then making sure the CI/CD pipelines are in place with the client's provider of choice. | ||
* [ ] Find out what the most suitable license would be. | ||
* [ ] Make section about TypeScript use more MECE | ||
* [ ] Write contributing guide | ||
@@ -121,0 +119,0 @@ * [ ] Complete testing section, add best practices |
16649
121