Compare commits
7 Commits
Author | SHA1 | Date | |
---|---|---|---|
b769dcae4f | |||
7b58535dda | |||
f16103a632 | |||
befed099c5 | |||
6c0fa380a9 | |||
22de2c784f | |||
e8fe4f1720 |
11
CHANGELOG
11
CHANGELOG
@ -1,11 +0,0 @@
|
|||||||
Please view this file on the master branch, on stable branches it's out of date.
|
|
||||||
|
|
||||||
v 6.0.0 (released)
|
|
||||||
- remove TypeDoc, please look at npmpage
|
|
||||||
- check package.json
|
|
||||||
|
|
||||||
v 7.0.0
|
|
||||||
- switch from mocha to tap
|
|
||||||
- run tests in SubProcesses with coverage
|
|
||||||
- improve ES6 handling
|
|
||||||
- add smartanalytics
|
|
38
docs/getstarted.md
Normal file
38
docs/getstarted.md
Normal file
@ -0,0 +1,38 @@
|
|||||||
|
---
|
||||||
|
name: Get Started
|
||||||
|
description: learn how to quickly write npm TypeScript modules
|
||||||
|
---
|
||||||
|
# Get Started with NPMTS
|
||||||
|
and learn how to quickly write npm TypeScript modules
|
||||||
|
|
||||||
|
## Step1: Install the tools
|
||||||
|
|
||||||
|
To use npmts install it using npm or yarn:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm install -g npmts # install with npm
|
||||||
|
yarn global add npmts # install with yarn
|
||||||
|
```
|
||||||
|
|
||||||
|
For the purpose of getting started quickly please also install **gitzone**.
|
||||||
|
It'll proovide awesome scaffolding for new npmts maintained modules and also updates them later on.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm install -g gitzone # install with npm
|
||||||
|
yarn global add gitzone # install with yarn
|
||||||
|
```
|
||||||
|
|
||||||
|
You can make sure npmts and gitzone are installed correctly by typing `npmts -v && gitzone -v`.
|
||||||
|
|
||||||
|
## Scaffold a new module
|
||||||
|
|
||||||
|
To scaffold a new module type
|
||||||
|
|
||||||
|
```shell
|
||||||
|
gitzone template npm
|
||||||
|
```
|
||||||
|
|
||||||
|
This will run you through a series of question to get gitzone to know the specifics of your module.
|
||||||
|
Enter all information accordingly.
|
||||||
|
|
||||||
|
## Run NPMTS for the first time
|
@ -1,8 +1,9 @@
|
|||||||
---
|
---
|
||||||
name: Start
|
name: Index
|
||||||
|
description: best practice npm TypeScript modules
|
||||||
---
|
---
|
||||||
# npmts
|
# npmts
|
||||||
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
best practice npm TypeScript modules
|
||||||
|
|
||||||
## Availabililty
|
## Availabililty
|
||||||
[](https://www.npmjs.com/package/npmts)
|
[](https://www.npmjs.com/package/npmts)
|
||||||
|
2
package-lock.json
generated
2
package-lock.json
generated
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "npmts",
|
"name": "npmts",
|
||||||
"version": "8.0.1",
|
"version": "8.0.4",
|
||||||
"lockfileVersion": 1,
|
"lockfileVersion": 1,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "npmts",
|
"name": "npmts",
|
||||||
"version": "8.0.1",
|
"version": "8.0.4",
|
||||||
"description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.",
|
"description": "best practice npm TypeScript modules",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"bin": {
|
"bin": {
|
||||||
"npmts": "assets/cliNpmts.js"
|
"npmts": "assets/cliNpmts.js"
|
||||||
@ -51,13 +51,13 @@
|
|||||||
"smartcli": "^2.0.7",
|
"smartcli": "^2.0.7",
|
||||||
"smartcov": "^1.0.2",
|
"smartcov": "^1.0.2",
|
||||||
"smarterror": "^1.0.3",
|
"smarterror": "^1.0.3",
|
||||||
"smartfile": "^4.2.17",
|
"smartfile": "^4.2.18",
|
||||||
"smartgulp": "^1.0.6",
|
"smartgulp": "^1.0.6",
|
||||||
"smartpath": "^3.2.8",
|
"smartpath": "^3.2.8",
|
||||||
"smartq": "^1.1.6",
|
"smartq": "^1.1.6",
|
||||||
"smartstream": "^1.0.10",
|
"smartstream": "^1.0.10",
|
||||||
"smartstring": "^2.0.24",
|
"smartstring": "^2.0.24",
|
||||||
"smartsystem": "^1.0.18",
|
"smartsystem": "^2.0.2",
|
||||||
"tapbuffer": "^1.0.29",
|
"tapbuffer": "^1.0.29",
|
||||||
"through2": "^2.0.3",
|
"through2": "^2.0.3",
|
||||||
"tsn": "^2.0.15",
|
"tsn": "^2.0.15",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
# npmts
|
# npmts
|
||||||
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
best practice npm TypeScript modules
|
||||||
|
|
||||||
## Availabililty
|
## Availabililty
|
||||||
[](https://www.npmjs.com/package/npmts)
|
[](https://www.npmjs.com/package/npmts)
|
||||||
|
58
yarn.lock
58
yarn.lock
@ -56,9 +56,9 @@
|
|||||||
dependencies:
|
dependencies:
|
||||||
"@types/node" "*"
|
"@types/node" "*"
|
||||||
|
|
||||||
"@types/fs-extra@3.x.x":
|
"@types/fs-extra@4.x.x":
|
||||||
version "3.0.3"
|
version "4.0.0"
|
||||||
resolved "https://registry.yarnpkg.com/@types/fs-extra/-/fs-extra-3.0.3.tgz#1d66eb670ebf657e57c0fda014df340c19d8aa0c"
|
resolved "https://registry.yarnpkg.com/@types/fs-extra/-/fs-extra-4.0.0.tgz#1dd742ad5c9bce308f7a52d02ebc01421bc9102f"
|
||||||
dependencies:
|
dependencies:
|
||||||
"@types/node" "*"
|
"@types/node" "*"
|
||||||
|
|
||||||
@ -1061,9 +1061,9 @@ fs-extra@^2.0.0, fs-extra@^2.1.2:
|
|||||||
graceful-fs "^4.1.2"
|
graceful-fs "^4.1.2"
|
||||||
jsonfile "^2.1.0"
|
jsonfile "^2.1.0"
|
||||||
|
|
||||||
fs-extra@^3.0.1:
|
fs-extra@^4.0.0:
|
||||||
version "3.0.1"
|
version "4.0.0"
|
||||||
resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-3.0.1.tgz#3794f378c58b342ea7dbbb23095109c4b3b62291"
|
resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-4.0.0.tgz#414fb4ca2d2170ba0014159d3a8aec3303418d9e"
|
||||||
dependencies:
|
dependencies:
|
||||||
graceful-fs "^4.1.2"
|
graceful-fs "^4.1.2"
|
||||||
jsonfile "^3.0.0"
|
jsonfile "^3.0.0"
|
||||||
@ -1175,7 +1175,7 @@ glob@^5.0.15, glob@^5.0.3:
|
|||||||
once "^1.3.0"
|
once "^1.3.0"
|
||||||
path-is-absolute "^1.0.0"
|
path-is-absolute "^1.0.0"
|
||||||
|
|
||||||
glob@^7.0.0, glob@^7.0.5, glob@^7.1.1:
|
glob@^7.0.0, glob@^7.0.5, glob@^7.1.1, glob@^7.1.2:
|
||||||
version "7.1.2"
|
version "7.1.2"
|
||||||
resolved "https://registry.yarnpkg.com/glob/-/glob-7.1.2.tgz#c19c9df9a028702d678612384a6552404c636d15"
|
resolved "https://registry.yarnpkg.com/glob/-/glob-7.1.2.tgz#c19c9df9a028702d678612384a6552404c636d15"
|
||||||
dependencies:
|
dependencies:
|
||||||
@ -1591,7 +1591,7 @@ js-tokens@^3.0.0:
|
|||||||
version "3.0.2"
|
version "3.0.2"
|
||||||
resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-3.0.2.tgz#9866df395102130e38f7f996bceb65443209c25b"
|
resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-3.0.2.tgz#9866df395102130e38f7f996bceb65443209c25b"
|
||||||
|
|
||||||
js-yaml@3.x, js-yaml@^3.2.7, js-yaml@^3.3.1, js-yaml@^3.4.2, js-yaml@^3.7.0, js-yaml@^3.8.3:
|
js-yaml@3.x, js-yaml@^3.2.7, js-yaml@^3.3.1, js-yaml@^3.4.2, js-yaml@^3.7.0, js-yaml@^3.9.1:
|
||||||
version "3.9.1"
|
version "3.9.1"
|
||||||
resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.9.1.tgz#08775cebdfdd359209f0d2acd383c8f86a6904a0"
|
resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.9.1.tgz#08775cebdfdd359209f0d2acd383c8f86a6904a0"
|
||||||
dependencies:
|
dependencies:
|
||||||
@ -2724,21 +2724,21 @@ smartfile@4.1.6:
|
|||||||
vinyl "^2.0.1"
|
vinyl "^2.0.1"
|
||||||
vinyl-file "^3.0.0"
|
vinyl-file "^3.0.0"
|
||||||
|
|
||||||
smartfile@^4.1.4, smartfile@^4.2.15, smartfile@^4.2.17:
|
smartfile@^4.1.4, smartfile@^4.2.15, smartfile@^4.2.17, smartfile@^4.2.18:
|
||||||
version "4.2.17"
|
version "4.2.18"
|
||||||
resolved "https://registry.yarnpkg.com/smartfile/-/smartfile-4.2.17.tgz#9eba8f65eea7e4db51aa30562f6039815a88b125"
|
resolved "https://registry.yarnpkg.com/smartfile/-/smartfile-4.2.18.tgz#8901f35bf5eb228674e6b786825fed57b6c1f3b3"
|
||||||
dependencies:
|
dependencies:
|
||||||
"@types/fs-extra" "3.x.x"
|
"@types/fs-extra" "4.x.x"
|
||||||
"@types/vinyl" "^2.0.0"
|
"@types/vinyl" "^2.0.0"
|
||||||
fs-extra "^3.0.1"
|
fs-extra "^4.0.0"
|
||||||
glob "^7.1.1"
|
glob "^7.1.2"
|
||||||
js-yaml "^3.8.3"
|
js-yaml "^3.9.1"
|
||||||
require-reload "0.2.2"
|
require-reload "0.2.2"
|
||||||
smartpath "^3.2.8"
|
smartpath "^3.2.8"
|
||||||
smartq "^1.1.1"
|
smartq "^1.1.6"
|
||||||
smartrequest "^1.0.4"
|
smartrequest "^1.0.6"
|
||||||
typings-global "^1.0.16"
|
typings-global "^1.0.20"
|
||||||
vinyl "^2.0.2"
|
vinyl "^2.1.0"
|
||||||
vinyl-file "^3.0.0"
|
vinyl-file "^3.0.0"
|
||||||
|
|
||||||
smartgulp@^1.0.6:
|
smartgulp@^1.0.6:
|
||||||
@ -2808,7 +2808,7 @@ smartq@^1.0.4, smartq@^1.1.0, smartq@^1.1.1, smartq@^1.1.6:
|
|||||||
typings-global "^1.0.19"
|
typings-global "^1.0.19"
|
||||||
util.promisify "^1.0.0"
|
util.promisify "^1.0.0"
|
||||||
|
|
||||||
smartrequest@^1.0.4:
|
smartrequest@^1.0.4, smartrequest@^1.0.6:
|
||||||
version "1.0.6"
|
version "1.0.6"
|
||||||
resolved "https://registry.yarnpkg.com/smartrequest/-/smartrequest-1.0.6.tgz#a006454332453b0a70d38a003a29963d039a7783"
|
resolved "https://registry.yarnpkg.com/smartrequest/-/smartrequest-1.0.6.tgz#a006454332453b0a70d38a003a29963d039a7783"
|
||||||
dependencies:
|
dependencies:
|
||||||
@ -2842,14 +2842,14 @@ smartstring@2.0.24, smartstring@^2.0.24:
|
|||||||
js-base64 "^2.1.9"
|
js-base64 "^2.1.9"
|
||||||
typings-global "^1.0.14"
|
typings-global "^1.0.14"
|
||||||
|
|
||||||
smartsystem@^1.0.18:
|
smartsystem@^2.0.2:
|
||||||
version "1.0.18"
|
version "2.0.2"
|
||||||
resolved "https://registry.yarnpkg.com/smartsystem/-/smartsystem-1.0.18.tgz#f1e9a19d1a6048d3e99c5ee95e64f728147da901"
|
resolved "https://registry.yarnpkg.com/smartsystem/-/smartsystem-2.0.2.tgz#89f94ff74cd6c5fae33d82bf0ef80233ef521215"
|
||||||
dependencies:
|
dependencies:
|
||||||
lik "^1.0.30"
|
lik "^1.0.38"
|
||||||
smartq "^1.1.1"
|
smartq "^1.1.6"
|
||||||
systemjs "^0.20.12"
|
systemjs "^0.20.17"
|
||||||
typings-global "^1.0.19"
|
typings-global "^1.0.20"
|
||||||
|
|
||||||
sntp@1.x.x:
|
sntp@1.x.x:
|
||||||
version "1.0.9"
|
version "1.0.9"
|
||||||
@ -3052,7 +3052,7 @@ symbol-observable@^1.0.1:
|
|||||||
version "1.0.4"
|
version "1.0.4"
|
||||||
resolved "https://registry.yarnpkg.com/symbol-observable/-/symbol-observable-1.0.4.tgz#29bf615d4aa7121bdd898b22d4b3f9bc4e2aa03d"
|
resolved "https://registry.yarnpkg.com/symbol-observable/-/symbol-observable-1.0.4.tgz#29bf615d4aa7121bdd898b22d4b3f9bc4e2aa03d"
|
||||||
|
|
||||||
systemjs@^0.20.12:
|
systemjs@^0.20.17:
|
||||||
version "0.20.17"
|
version "0.20.17"
|
||||||
resolved "https://registry.yarnpkg.com/systemjs/-/systemjs-0.20.17.tgz#b3143bb7e02d2f41b9a640351a06024b7b63ae59"
|
resolved "https://registry.yarnpkg.com/systemjs/-/systemjs-0.20.17.tgz#b3143bb7e02d2f41b9a640351a06024b7b63ae59"
|
||||||
|
|
||||||
@ -3375,7 +3375,7 @@ vinyl@^0.5.0:
|
|||||||
clone-stats "^0.0.1"
|
clone-stats "^0.0.1"
|
||||||
replace-ext "0.0.1"
|
replace-ext "0.0.1"
|
||||||
|
|
||||||
vinyl@^2.0.1, vinyl@^2.0.2:
|
vinyl@^2.0.1, vinyl@^2.1.0:
|
||||||
version "2.1.0"
|
version "2.1.0"
|
||||||
resolved "https://registry.yarnpkg.com/vinyl/-/vinyl-2.1.0.tgz#021f9c2cf951d6b939943c89eb5ee5add4fd924c"
|
resolved "https://registry.yarnpkg.com/vinyl/-/vinyl-2.1.0.tgz#021f9c2cf951d6b939943c89eb5ee5add4fd924c"
|
||||||
dependencies:
|
dependencies:
|
||||||
|
Reference in New Issue
Block a user