0.1.4 • Published 1 year ago

@wang1212/itools v0.1.4

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

itools

LICENSE NPM VERSION DOWNLOAD LAST COMMIT GITHUB PACKAGE CI Commitizen friendly Codacy Badge

English | 简体中文

:package: Common toolbox.

This package is now pure ESM, read this.

Tools

inpm-utils

This tool will install some useful npm packages globally.

iproxy

This tool will provide operations to enable, disable, and configure the git/npm proxy.

Essentially, it does something like this:

git config --global http.proxy <proxy>
npm config --global set proxy <proxy>

Tips: this does not automatically set the environment variables http_proxy, HTTP_PROXY, https_proxy, HTTPS_PROXY.

Usage

  • Use directly without installation, run:

    npx @wang1212/itools
  • Or, install globally:

    npm install --global @wang1212/itools
    
    // run command using tool
    itools

Tips: after a local global installation, a command such as iproxy is provided for each tool in addition to the command itools. In other words, instead of running itools and then selecting the iproxy tool, you can run the iproxy command directly.

Development Guidelines

Git Commit Message Format

Adopt community commit format best practices:

# Before
git commit

# Now
npm run commit

This constraint relies on tools commitizen and commitlint provided by the community.

npm publish

The version management of this module adopts the specifications recommended by the community Semantic Versioning. Follow version changes and maintain a CHANGELOG.md(Learn why).

# Update version and generate changelog before publishing to npm repository
npm run release # npm run release -- --first-release
# Or, preview
npm run release -- --dry-run

# Then
npm publish # npm publish --access public

These jobs are done with the help of standard-version tool provided by the community.

Inspiration

The inspiration for creating this toolbox came from the wsl2proxy/nrm programs, and after using them, I wondered if I could write the tedious things that need to be done by hand every day as a programmatic gadget for ease of use and efficiency.

License

MIT.