Skip to content

Commit

Permalink
docs ~ (README) updated build/contribution documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rivy committed Aug 1, 2022
1 parent 4b86808 commit 4884af6
Showing 1 changed file with 30 additions and 2 deletions.
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,19 +193,36 @@ console.log(osPaths.temp());

- NodeJS >= 10.14
- a JavaScript package/project manager ([`npm`](https://www.npmjs.com/get-npm) or [`yarn`](https://yarnpkg.com))
- [`git`](https://git-scm.com)

> #### optional
>
> - [`git-changelog`](https://github.com/rivy-go/git-changelog) (v1.1+) ... enables changelog automation
> - [`perl`](https://www.perl.org) ... enables automated version updates to **`package.json`** during packaging
### Build/test
### Quick build/test

```shell
npm install-test
```

### Project development scripts
### Contributions/development

#### _Reproducible_ setup (for CI or local development)

```shell
git clone "https://github.com/rivy/js.os-paths"
cd js.os-paths
# * note: for WinOS, replace `cp` with `copy`
# npm
cp .deps-lock/package-lock.json .
npm clean-install
# yarn
cp .deps-lock/yarn.lock .
yarn --immutable --immutable-cache --check-cache
```

#### Project development scripts

```shell
> npm run help
Expand All @@ -228,8 +245,10 @@ lint:lint check for code 'lint' (using `eslint`)
lint:markdown check for markdown errors (using `remark`)
lint:spell check for spelling errors (using `cspell`)
lint:style check for format imperfections (using `prettier`)
prerelease clean, rebuild, and fully test prior to publish/release
realclean remove all generated files
rebuild clean and (re-)build project
rebuild:all clean and fully reconstruct project distribution
retest clean and (re-)test project
reset:hard remove *all* generated files and reinstall dependencies
show:deps show package dependencies
Expand Down Expand Up @@ -259,7 +278,11 @@ git commit -m "${VERSION}"
npm run clean && npm run update:dist
git add dist
git commit --amend --no-edit
# tag VERSION commit
git tag -f "v${VERSION}"
# (optional) save dependency locks
mkdir .deps-lock 2> /dev/null
cp package-lock.json yarn.lock .deps-lock/
#=== * WinOS
@rem ::# next VERSION in M.m.r (semver) format
set VERSION=...
Expand All @@ -273,7 +296,12 @@ git commit -m "%VERSION%"
npm run clean && npm run update:dist
git add dist
git commit --amend --no-edit
@rem ::# tag VERSION commit
git tag -f "v%VERSION%"
@rem ::# (optional) save dependency locks
mkdir .deps-lock 2>NUL
copy package-lock.json .deps-lock/
copy yarn.lock .deps-lock/
```

##### Publish
Expand Down

0 comments on commit 4884af6

Please sign in to comment.