tunnckocore/xaxa

:star2: Zero-config linting, powered by few amazing unicorns :unicorn:, AirBnB :revolving_hearts: & Prettier :tada:

xaxa

🌟 Zero-config linting, powered by few amazing unicorns 🦄, AirBnB 💞 & Prettier 🎉

If you have any how-to kind of questions, please read the Contributing Guide and Code of Conduct documents.
For bugs reports and feature requests, please create an issue or ping @tunnckoCore at Twitter.

Project is semantically & automatically released on CircleCI with new-release and its New Release GitHub App.

Table of Contents

• Install
• API
• Related Projects
• Contributing
• Contributors
• Users
• License

Install

This project requires Node.js ^8.9.0 || ^10.6.0. Install it using yarn or npm.
We highly recommend to use Yarn when you think to contribute to this project.

$ yarn add xaxa --dev

# or globally
$ yarn global add xaxa

# then just run
$ xaxa

API

back to top

Related Projects

Some of these projects are used here or were inspiration for this one, others are just related. So, thanks for your existance!

• asia: Blazingly fast, magical and minimalist testing framework, for Today and Tomorrow | homepage
• charlike: Small, fast, simple and streaming project scaffolder for myself, but not… more | homepage
• gitcommit: Lightweight and joyful git commit replacement. Conventional Commits compliant. | homepage
• new-release: A stable alternative to semantic-release. Only handles NPM publishing and nothing… more | homepage
• xaxa: Zero-config linting, powered by few amazing unicorns, AirBnB & Prettier. | homepage

back to top

Contributing

Please read the Contributing Guide and Code of Conduct documents for advices.
For bugs reports and feature requests, please create an issue or ping @tunnckoCore at Twitter.

Contributors

Thanks to the hard work of these wonderful people this project is alive and it also follows the all-contributors specification.
Pull requests, stars and all kind of contributions are always welcome. 🌟

Users

You can see who uses xaxa in the USERS.md file. Please feel free adding this file if it not exists.
If you or your organization are using this project, consider adding yourself to the list of users.
Thank You! ❤️

License

Copyright (c) 2018-present, Charlike Mike Reagent <[email protected]>.
Released under the Apache-2.0 License.

---

This file was generated by verb-generate-readme, v0.7.0, on July 25, 2018.

xaxa's Issues

Read config from `xaxa` and `eslintConfig` fields

from the package.json...

We should do this, because when for example use eslintConfig to disable some rule and then run xaxa it does not respect that.

Refactor index.js:normalizeOptions

I've selected index.js:normalizeOptions for refactoring, which is a unit of 25 lines of code. Addressing this will make our codebase more maintainable and improve Better Code Hub's Write Short Units of Code guideline rating! 👍

Here's the gist of this guideline:

• Definition 📖
  Limit the length of code units to 15 lines of code.
• Why❓
  Small units are easier to analyse, test and reuse.
• How 🔧
  When writing new units, don't let them grow above 15 lines of code. When a unit grows beyond this, split it in smaller units of no longer than 15 lines.

You can find more info about this guideline in Building Maintainable Software. 📖

---

ℹ️ To know how many other refactoring candidates need addressing to get a guideline compliant, select some by clicking on the 🔲 next to them. The risk profile below the candidates signals (✅) when it's enough! 🏁

---

Good luck and happy coding! ✨ 💯

Extract thoughts from code comments to README

and more things.

Expose API & better CLI experience

Asynchronous methods lintText(text, options) and lintFiles(patterns, options).

Also to this, the config will be extracted to eslint-config-xaxa, so we can both use eslintConfig.extends field (because better editor integration) and the CLI for precommit things and such.

Needed updates for AirBnB 17 / 13

Change function-paren-newline back to multiline (in anyway, it's just handled by prettier, i believe... even, probably disabled by prettier's config)

function-paren-newline: ["error", "multiline"]

Other than that... Just upgrade to v17 (main) and v13 (base)

use flow-copy-source, ascjs, flow-remove-types

so we are lightweight

Configurable `reportUnusedDisableDirectives`

It gets pretty weird sometimes.

Needless option in `arrow-parens` rule

https://github.com/olstenlarck/xaxa/blob/master/src/index.mjs#L19 remove the option