1.0.2 • Published 1 year ago

@patomation/nps v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

NPM Package Starter

NNNNNNNN        NNNNNNNN PPPPPPPPPPPPPPPPP       SSSSSSSSSSSSSSS
N:::::::N       N::::::N P::::::::::::::::P    SS:::::::::::::::S
N::::::::N      N::::::N P::::::PPPPPP:::::P  S:::::SSSSSS::::::S
N:::::::::N     N::::::N PP:::::P     P:::::P S:::::S     SSSSSSS
N::::::::::N    N::::::N   P::::P     P:::::P S:::::S
N:::::::::::N   N::::::N   P::::P     P:::::P S:::::S
N:::::::N::::N  N::::::N   P::::PPPPPP:::::P   S::::SSSS
N::::::N N::::N N::::::N   P:::::::::::::PP     SS::::::SSSSS
N::::::N  N::::N:::::::N   P::::PPPPPPPPP         SSS::::::::SS
N::::::N   N:::::::::::N   P::::P                    SSSSSS::::S
N::::::N    N::::::::::N   P::::P                         S:::::S
N::::::N     N:::::::::N   P::::P                         S:::::S
N::::::N      N::::::::N PP::::::PP           SSSSSSS     S:::::S
N::::::N       N:::::::N P::::::::P           S::::::SSSSSS:::::S
N::::::N        N::::::N P::::::::P           S:::::::::::::::SS
NODE___N         N_____N PACKAGE_P            STARTER_________S

The goal here is to have a vanilla project starter that includes TypeScript. In addition it has commit lint and ava for testing. So not so vanilla. More of a minimal preset. You get to chose your preferred front end framework. Enjoy making things.

Features

  • TypeScript
  • ava test framework
  • nyc test coverage reporter
  • standard-version
  • commit-lint
  • husky
  • prettier
  • pretty-quick staged formatting
  • clunk 4kb cli arg parser

flavorite

Install

npm i -G @patomation/nps

Starting a new project

nps new my-new-ts-npm-package
cd my-new-ts-npm-package
npm i

Updating an existing project

cd my-new-ts-npm-package
nps update
npm i

Development

Install

npm install

Test

npm run test
# or
npm run watch:test

Available NPM Scripts:

npm run ...

ScriptNotes
compile:tests
compile:package
compileboth test and package
buildtranspile TyScript to JS /build dir
unitrun ava on /build
unit:coveragerun coverage on /build
testcompile /build and run unit tests
coveragecompile /build and test coverage report
watch:compilewatch for change in src
watch:testrun tests when src changes
releasetrigger standard-version
publishhook to push tags on npm publish
preparehook to install huksy on npm i
prettierformat all files with prettier
1.0.2

1 year ago

1.0.1

1 year ago