Skip to content

🔧 A tool for linting and building assets from yProx CMS.

Notifications You must be signed in to change notification settings

Yproximite/yProx-CLI

Repository files navigation

yProx-CLI

CI

A tool for bulk linting and building assets.

Another tool?

Yes, but linting and building a lot of assets is now easier than ever!

Out of the box, yProx-CLI comes with:

  • JavaScript support (+ Buble)
  • CSS and Sass support
  • Rollup support (JavaScript, Vue, GraphQL) for modern apps
  • ESLint for linting JavaScript files
  • Stylelint for linting CSS and Sass support
  • Copy/Paste files
  • Images optimization

yProx-CLI is really useful for us because it allowed us to package all the tools we need in only big package.

We have ~150 WordPress projects and it was really hard to maintain ~25 dev dependencies (for Gulp) for each project. Using yProx-CLI saves us some huge amount of time because:

  • we were able to externalize all those dependencies in one package
  • we were able to externalize the tooling in one package. Before, everything was in a Gulp file configuration

Documentation

Read the documentation.

Development workflow

You need to install dependencies first:

$ yarn

Tests

Tests are located inside the test folder. You can run them with:

$ yarn test

Be sure to always add a test when you are modifying something!

Linting

We use ESlint, the AirBnb preset, the Recommended rules for TypeScript, and Prettier.

You can lint the code with:

$ yarn lint
$ yarn lint --fix # will automatically fix some errors

Contribution

Publishing a new release

  • Open a PR develop to master
  • Merge your pull request with a Merge commit