chore(shrinkwrap): remove shrinkwrap (#106)
This commit is contained in:
parent
f3819a6aac
commit
5a8c457972
7 changed files with 3 additions and 13855 deletions
|
|
@ -1,5 +1,2 @@
|
|||
dev/bundle.js*
|
||||
# we do not want to lock down dependencies when used as an npm dependency,
|
||||
# only when we build
|
||||
npm-shrinkwrap.json
|
||||
demo.gif
|
||||
|
|
|
|||
|
|
@ -14,9 +14,6 @@ Hi (future) collaborator!
|
|||
- [Development workflow](#development-workflow)
|
||||
- [Local example](#local-example)
|
||||
- [Documentation website](#documentation-website)
|
||||
- [Adding/Updating a package](#addingupdating-a-package)
|
||||
- [Removing a package](#removing-a-package)
|
||||
- [In case of shrinkwrap madness](#in-case-of-shrinkwrap-madness)
|
||||
- [Commit message guidelines](#commit-message-guidelines)
|
||||
- [Revert](#revert)
|
||||
- [Type](#type)
|
||||
|
|
@ -51,7 +48,7 @@ We use a simple documentation example website as a way to develop the docsearch.
|
|||
Requirements:
|
||||
- [Node.js](https://nodejs.org/en/)
|
||||
- npm@2
|
||||
|
||||
|
||||
```sh
|
||||
npm run dev
|
||||
# open http://localhost:8080
|
||||
|
|
@ -71,41 +68,6 @@ npm run dev:docs
|
|||
open http://localhost:4000/docsearch/
|
||||
```
|
||||
|
||||
# Adding/Updating a package
|
||||
|
||||
We use a [specific shrinkwrapping tool](https://github.com/uber/npm-shrinkwrap) and npm@2.
|
||||
|
||||
```sh
|
||||
npm install
|
||||
npm install package --save[-dev]
|
||||
npm run shrinkwrap
|
||||
```
|
||||
|
||||
# Removing a package
|
||||
|
||||
```sh
|
||||
npm install
|
||||
npm remove package --save[-dev]
|
||||
npm run shrinkwrap
|
||||
```
|
||||
|
||||
Removing packages can be really tricky to handle if the package was used by
|
||||
both the host project and sub dependencies.
|
||||
|
||||
# In case of shrinkwrap madness
|
||||
|
||||
```sh
|
||||
rm -rf node_modules
|
||||
rm npm-shrinkwrap.json
|
||||
npm cache clean
|
||||
npm install
|
||||
# check everything is working
|
||||
npm run shrinkwrap
|
||||
```
|
||||
|
||||
Don't do this too often because it breaks the whole shrinkwrap idea. Since
|
||||
you are completely rebuilding the dependency tree and possibly updating things.
|
||||
|
||||
# Commit message guidelines
|
||||
|
||||
We use [conventional changelog](https://github.com/ajoslin/conventional-changelog) to generate our changelog from our git commit messages.
|
||||
|
|
|
|||
13808
npm-shrinkwrap.json
generated
13808
npm-shrinkwrap.json
generated
File diff suppressed because it is too large
Load diff
|
|
@ -7,7 +7,6 @@
|
|||
"dev": "./scripts/dev",
|
||||
"dev:docs": "./scripts/dev-docs",
|
||||
"serve": "./scripts/serve",
|
||||
"shrinkwrap": "npm-shrinkwrap --dev",
|
||||
"doctoc": "doctoc --maxlevel 3 README.md CONTRIBUTING.md",
|
||||
"build": "./scripts/build",
|
||||
"build:css": "./scripts/build-css",
|
||||
|
|
@ -51,7 +50,6 @@
|
|||
"mversion": "^1.10.1",
|
||||
"nd": "^1.2.0",
|
||||
"node-sass": "^3.4.2",
|
||||
"npm-shrinkwrap": "^200.4.0",
|
||||
"onchange": "^2.0.0",
|
||||
"postcss-cli": "^2.3.2",
|
||||
"pretty-bytes": "^2.0.1",
|
||||
|
|
|
|||
|
|
@ -68,7 +68,7 @@ npm run doctoc
|
|||
|
||||
# git add and tag
|
||||
commitMessage="v$newVersion\n\n$changelog"
|
||||
git add src/lib/version.js npm-shrinkwrap.json package.json CHANGELOG.md README.md CONTRIBUTING.md
|
||||
git add src/lib/version.js package.json CHANGELOG.md README.md CONTRIBUTING.md
|
||||
printf "$commitMessage" | git commit --file -
|
||||
git tag "v$newVersion"
|
||||
|
||||
|
|
|
|||
|
|
@ -76,7 +76,7 @@ touch $tmpfile
|
|||
|
||||
# git add and tag
|
||||
commitMessage="v$newVersion\n\n$changelog"
|
||||
git add src/lib/version.js npm-shrinkwrap.json package.json CHANGELOG.md CONTRIBUTING.md README.md
|
||||
git add src/lib/version.js package.json CHANGELOG.md CONTRIBUTING.md README.md
|
||||
printf "$commitMessage" | git commit --file -
|
||||
|
||||
printf "\n\nBeta release: almost done, check everything in another terminal tab.\n"
|
||||
|
|
|
|||
|
|
@ -5,7 +5,6 @@ set -ev # exit when error
|
|||
./scripts/validate-pr-done-on-develop
|
||||
npm run test:coverage
|
||||
npm prune
|
||||
npm run shrinkwrap --dev
|
||||
NODE_ENV=production npm run build
|
||||
./scripts/validate-commit-msgs
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue