0.6.0 • Published 6 years ago
@new/project v0.6.0
@new/project
Create a basic JS project.
The package does the following:
- Adds
package.json
by usingnpm init
. - Adds
.gitignore
with entries for JS. - Adds
readme.md
that is empty.
Usage
Beware: This is a simple shell script, and has ability to overwrite files. It tries to be interactive as possible, but know what the script is doing before you decide to execute it.
Use the package with npx
:
$ npx @new/project
(When using npm
instead you still need npx
installed)
Customize
To customize see files/
, bin/
, and package.json
. Things to notice:
- Everything at the base of
files/
is prefixed with_
, e.g._.gitignore
so the files don't conflict with source control or other tools. - There is a confirm prompt before the script can run.
- You have helper vars defined at the top:
$SOURCE
is thefiles/
directory of this script$DEST
is the directory where the files are being wrote$ROOT
is thepackage.json
directory the script
- Use
npx
to execute npm dependencies in your shell scripts. - The script should be tailored towards you, not accept a lot of inputs.
Besides this, it is simply a bash script you can use.
Extras
Also check out the projects:
@new/project-web
Create a JS + SCSS + Make project for the web.@jamen/watch-exec
File watching utility.dist-js
Create dist version of your JS.dist-css
Create dist version of your CSS.