-
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.
- Loading branch information
1 parent
336d127
commit fdd0bd8
Showing
7 changed files
with
39 additions
and
135 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
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
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,13 +1,13 @@ | ||
{ | ||
"workbench.colorCustomizations": { | ||
"titleBar.activeBackground": "#212121", | ||
"titleBar.border": "#CB3837", | ||
"titleBar.border": "#41AF73", | ||
"titleBar.activeForeground": "#F0F0F0", | ||
"statusBar.background": "#212121", | ||
"statusBar.border":"#CB3837", | ||
"statusBar.border":"#41AF73", | ||
"statusBar.foreground": "#F0F0F0", | ||
"activityBar.activeBorder": "#CB3837", | ||
"activityBarBadge.foreground":"#F0F0F0", | ||
"activityBarBadge.background":"#CB3837", | ||
"activityBar.activeBorder": "#41AF73", | ||
"activityBarBadge.foreground":"#212121", | ||
"activityBarBadge.background":"#41AF73", | ||
}, | ||
} |
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,137 +1,41 @@ | ||
# Node Module Starter 🛠️ | ||
# Stream Writer 🪶 | ||
|
||
[![NPM Latest Version][version-badge]][npm-url] [![Coverage Status][coverage-badge]][coverage-url] [![NPM Monthly Downloads][downloads-badge]][npm-url] [![Dependencies][deps-badge]][deps-url] | ||
|
||
[version-badge]: https://img.shields.io/npm/v/%40alessiofrittoli%2Fnode-module-starter | ||
[npm-url]: https://npmjs.org/package/%40alessiofrittoli%2Fnode-module-starter | ||
[coverage-badge]: https://coveralls.io/repos/github/alessiofrittoli/node-module-starter/badge.svg | ||
[coverage-url]: https://coveralls.io/github/alessiofrittoli/node-module-starter | ||
[downloads-badge]: https://img.shields.io/npm/dm/%40alessiofrittoli%2Fnode-module-starter.svg | ||
[deps-badge]: https://img.shields.io/librariesio/release/npm/%40alessiofrittoli%2Fnode-module-starter | ||
[deps-url]: https://libraries.io/npm/%40alessiofrittoli%2Fnode-module-starter | ||
[version-badge]: https://img.shields.io/npm/v/%40alessiofrittoli%2Fstream-writer | ||
[npm-url]: https://npmjs.org/package/%40alessiofrittoli%2Fstream-writer | ||
[coverage-badge]: https://coveralls.io/repos/github/alessiofrittoli/stream-writer/badge.svg | ||
[coverage-url]: https://coveralls.io/github/alessiofrittoli/stream-writer | ||
[downloads-badge]: https://img.shields.io/npm/dm/%40alessiofrittoli%2Fstream-writer.svg | ||
[deps-badge]: https://img.shields.io/librariesio/release/npm/%40alessiofrittoli%2Fstream-writer | ||
[deps-url]: https://libraries.io/npm/%40alessiofrittoli%2Fstream-writer | ||
|
||
## Starter repository for developing node_modules | ||
## Easly push data to a Stream | ||
|
||
### Table of Contents | ||
|
||
- [Getting started](#getting-started) | ||
- [Development](#development) | ||
- [ESLint](#eslint) | ||
- [Jest](#jest) | ||
- [Contributing](#contributing) | ||
- [Security](#security) | ||
- [Credits](#made-with-) | ||
|
||
--- | ||
|
||
### Getting started (delete once cloned in your project) | ||
### Getting started | ||
|
||
Run the following command to start using `node-module-starter` for your projects: | ||
Run the following command to start using `stream-writer` in your projects: | ||
|
||
```bash | ||
git clone [email protected]:alessiofrittoli/node-module-starter.git && git remote remove origin | ||
``` | ||
|
||
install dependencies | ||
|
||
```bash | ||
pnpm i | ||
``` | ||
|
||
Read the [Creating a repository from a template - GitHub Docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) for more in-detail informations about creating a new Repository from a template using GitHub web interface. | ||
|
||
--- | ||
|
||
### Getting started (customize based on your project needs) | ||
|
||
Run the following command to start using `{package_name}` in your projects: | ||
|
||
```bash | ||
npm i {package_name} | ||
``` | ||
|
||
or using `pnpm` | ||
|
||
```bash | ||
pnpm i {package_name} | ||
``` | ||
|
||
--- | ||
|
||
### Development | ||
|
||
#### Install depenendencies | ||
|
||
```bash | ||
npm install | ||
npm i @alessiofrittoli/stream-writer | ||
``` | ||
|
||
or using `pnpm` | ||
|
||
```bash | ||
pnpm i | ||
``` | ||
|
||
#### Build the source code | ||
|
||
Run the following command to test and build code for distribution. | ||
|
||
```bash | ||
pnpm build | ||
``` | ||
|
||
#### [ESLint](https://www.npmjs.com/package/eslint) | ||
|
||
warnings / errors check. | ||
|
||
```bash | ||
pnpm lint | ||
``` | ||
|
||
#### [Jest](https://npmjs.com/package/jest) | ||
|
||
Run all the defined test suites by running the following: | ||
|
||
```bash | ||
# Run tests and watch file changes. | ||
pnpm test:watch | ||
|
||
# Run tests and watch file changes with jest-environment-jsdom. | ||
pnpm test:jsdom | ||
|
||
# Run tests in a CI environment. | ||
pnpm test:ci | ||
|
||
# Run tests in a CI environment with jest-environment-jsdom. | ||
pnpm test:ci:jsdom | ||
``` | ||
|
||
You can eventually run specific suits like so: | ||
|
||
```bash | ||
pnpm test:jest | ||
pnpm test:jest:jsdom | ||
``` | ||
|
||
Run tests with coverage. | ||
|
||
An HTTP server is then started to serve coverage files from `./coverage` folder. | ||
|
||
⚠️ You may see a blank page the first time you run this command. Simply refresh the browser to see the updates. | ||
|
||
```bash | ||
test:coverage:serve | ||
pnpm i @alessiofrittoli/stream-writer | ||
``` | ||
|
||
--- | ||
|
||
### Contributing | ||
|
||
Contributions are truly welcome!\ | ||
Please refer to the [Contributing Doc](./CONTRIBUTING.md) for more information on how to start contributing to this project. | ||
|
||
--- | ||
|
||
### Security | ||
|
||
If you believe you have found a security vulnerability, we encourage you to **_responsibly disclose this and NOT open a public issue_**. We will investigate all legitimate reports. Email `[email protected]` to disclose any security vulnerabilities. | ||
|
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,26 +1,26 @@ | ||
{ | ||
"name": "@alessiofrittoli/node-module-starter", | ||
"version": "1.3.0", | ||
"description": "Starter repository for developing node_modules", | ||
"name": "@alessiofrittoli/stream-writer", | ||
"version": "0.1.0", | ||
"description": "Easly push data to a Stream", | ||
"author": { | ||
"name": "Alessio Frittoli", | ||
"email": "[email protected]", | ||
"url": "https://alessiofrittoli.it" | ||
}, | ||
"license": "MIT", | ||
"keywords": [ | ||
"nodejs", | ||
"npm", | ||
"node_modules" | ||
"stream", | ||
"stream-writer", | ||
"streaming" | ||
], | ||
"homepage": "https://github.com/alessiofrittoli/node-module-starter#readme", | ||
"homepage": "https://github.com/alessiofrittoli/stream-writer#readme", | ||
"bugs": { | ||
"url": "https://github.com/alessiofrittoli/node-module-starter/issues", | ||
"url": "https://github.com/alessiofrittoli/stream-writer/issues", | ||
"email": "[email protected]" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "git+https://github.com/alessiofrittoli/node-module-starter.git" | ||
"url": "git+https://github.com/alessiofrittoli/stream-writer.git" | ||
}, | ||
"main": "./dist/index.js", | ||
"module": "./dist/index.mjs", | ||
|
@@ -30,10 +30,10 @@ | |
], | ||
"sideEffects": false, | ||
"scripts": { | ||
"build": "pnpm lint && pnpm test:ci && pnpm test:ci:jsdom && tsup", | ||
"build": "pnpm lint && pnpm test:ci && tsup", | ||
"build:watch": "tsup --watch", | ||
"lint": "eslint", | ||
"release": "node scripts/publish.js --verbose", | ||
"release": "node scripts/publish.js --verbose --npm", | ||
"test": "jest", | ||
"test:watch": "jest --watchAll --verbose", | ||
"test:jsdom": "JSDOM=true pnpm test:watch", | ||
|