Giter Site home page Giter Site logo

exlint / cli Goto Github PK

View Code? Open in Web Editor NEW
29.0 1.0 1.0 13.33 MB

Exlint CLI ๐Ÿ“ฆ๏ธ Centralize coding standards across repositories in seconds.

License: Other

JavaScript 15.89% Shell 0.20% TypeScript 83.91%
centralized code-analysis-tool code-quality lint best-practices coding-standards cli compliance static-code-analysis command-line-tool

cli's Introduction

CI status npm downloads npm license version

ย 

Exlint CLI (Not Maintained)

๐Ÿ‘ฉ๐Ÿปโ€๐Ÿ’ป Centralized Code Standards: Keep your code clean and standardized over multiple repositories.

๐Ÿ“ฆ๏ธ Grouped & Sharable Compliances: Share and run your coding conventions over any repositories.

๐Ÿš€ CI Workflow: Integrate Exlint into your workflow to continuously prevent coding bad practices.

Table of Contents

Getting Started

We recommend installing Exlint CLI globally using npm:

npm install --global @exlint.io/cli

You can also install it locally:

npm install --save-dev @exlint.io/cli

๐Ÿš€ Go Command

exlint go

Get started quickly with Exlint using our go command.

Exlint will create a recommended multi-policy compliance based on your project language, and will run the compliance linting result on your terminal.

You can then easily create an account and customize the recommended compliance as you wish (or start from scratch).

Running from command line

Exlint

You can run Exlint directly from the CLI (if it's globally available in your PATH, e.g. by npm install --global @exlint.io/cli) with a variety of useful commands. If you haven't installed Exlint CLI globally, but locally, you can use it in the CLI by using npx.

Auth Command

exlint auth

Exlint requires you to authenticate. This will allow you to use your configured compliances in the CLI. First, you should make sure you have created an account and configured your compliance. When running the command, you will be prompted to your browser to authenticate yourself. After doing so, you can return back to the CLI and start using Exlint!

Use Command

exlint use <compliance_id>

When you want to use a compliance you have created in the dashboard, you copy its unique identifier and use it with the use command. Exlint will adjust your IDE (if using VSCode or Webstorm), install required extensions and libraries. You can easily switch compliances by using the command again!

Run Command

exlint run [options]

After running the use command, you can run your compliance over your code to get CLI results. Exlint will run your configured libraries against your code and report upon success or failure runs. If your code fails to match the configured code standards, Exlint will report the issues in the CLI.

Options

You can also run the command with --fix or -f option. Providinig this option will make Exlint try to automatically fix your code issues.

CI Workflows

You can run your centralized Exlint compliance also in CI. If you want to integrate an Exlint step in your workflow, you can use the GitHub Action

Privacy

Exlint does not and will not, in any way, view / copy / obtain access or intrude user code. Our CLI is 100% open source and will stay this way. Open source libraries should stay open source, and not used as a means to an end of obscuring privacy.

Contributing

Development of Exlint CLI happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements.

Code of Conduct

Exlint has adopted a Code of Conduct that we expect project participants to adhere to.

License

Exlint is Apache 2.0 Licensed.

cli's People

Contributors

renovate-bot avatar renovate[bot] avatar roy-shiloh avatar semantic-release-bot avatar tal-rofe avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

geekwolverine

cli's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Warning

These dependencies are deprecated:

Datasource Name Replacement PR?
npm eslint-plugin-node Available
npm npm-run-all Available

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

  • chore: ๐Ÿค– update dependency @compodoc/compodoc to v1.1.25
  • chore: ๐Ÿค– update dependency @types/envinfo to v7.8.4
  • chore: ๐Ÿค– update dependency @types/react to v18.3.3
  • chore: ๐Ÿค– update dependency eslint-plugin-react to v7.34.3
  • chore: ๐Ÿค– update dependency lint-staged to v15.2.7
  • chore: ๐Ÿค– update nest monorepo to v10.3.9 (@nestjs/common, @nestjs/core)
  • chore: ๐Ÿค– update dependency axios to v1.7.2
  • chore: ๐Ÿค– update dependency node to v20.15.0 (node, @types/node)
  • chore: ๐Ÿค– update dependency prettier to v3.3.2
  • chore: ๐Ÿค– update dependency typescript to v5.5.2
  • chore: ๐Ÿค– update dependency webpack to v5.92.1
  • chore: ๐Ÿค– update dependency eslint to v9
  • chore: ๐Ÿค– update dependency eslint-plugin-unused-imports to v4
  • chore: ๐Ÿค– update dependency ink to v5
  • ๐Ÿ” Create all rate-limited PRs at once ๐Ÿ”

Pending Status Checks

These updates await pending status checks. To force their creation now, click the checkbox below.

  • chore: ๐Ÿค– update dependency nest-commander to v3.14.0

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions
.github/workflows/commitlint.yaml
  • actions/checkout v4
  • wagoid/commitlint-github-action v5
.github/workflows/integrate.yaml
  • Exlint/node-environment v1.2.6
  • Exlint/node-environment v1.2.6
  • Exlint/node-environment v1.2.6
  • Exlint/node-environment v1.2.6
  • Exlint/node-environment v1.2.6
  • Exlint/node-environment v1.2.6
.github/workflows/release.yaml
  • Exlint/node-environment v1.2.6
  • cycjimmy/semantic-release-action v4.1.0
npm
package.json
  • @nestjs/common ^10.0.0
  • @nestjs/core ^10.0.0
  • axios 1.6.8
  • chalk 5.3.0
  • cli-spinners 2.9.2
  • envinfo 7.13.0
  • express 4.19.2
  • fs-extra 11.2.0
  • ink 4.4.1
  • ink-divider 3.0.0
  • ink-spinner 5.0.0
  • ink-task-list 2.0.0
  • is-ci 3.0.1
  • nest-commander 3.13.0
  • netrc-parser 3.1.6
  • open 9.1.0
  • react 18.3.1
  • reflect-metadata ^0.2.0
  • rxjs 7.8.1
  • v8-compile-cache 2.4.0
  • @commitlint/cli 18.6.1
  • @compodoc/compodoc 1.1.24
  • @exlint.io/inflint 2.0.2
  • @nestjs/cli 10.3.2
  • @types/envinfo 7.8.3
  • @types/express 4.17.21
  • @types/fs-extra 11.0.4
  • @types/ink-divider 2.0.4
  • @types/inquirer 9.0.7
  • @types/is-ci 3.0.4
  • @types/node 20.12.8
  • @types/react 18.3.1
  • @typescript-eslint/eslint-plugin 5.62.0
  • @typescript-eslint/parser 5.62.0
  • commitizen 4.3.0
  • cross-env 7.0.3
  • cz-vinyl 2.5.1
  • depcheck 1.4.7
  • eslint 8.57.0
  • eslint-config-prettier 9.1.0
  • eslint-plugin-import 2.29.1
  • eslint-plugin-node 11.1.0
  • eslint-plugin-react 7.34.1
  • eslint-plugin-unused-imports 3.2.0
  • figlet 1.7.0
  • husky 8.0.3
  • lint-staged 15.2.2
  • npm-run-all 4.1.5
  • open-cli 7.2.0
  • prettier 3.2.5
  • ts-loader 9.5.1
  • typescript 5.4.5
  • webpack 5.91.0
  • webpack-merge 5.10.0
  • @types/inquirer 9.0.7
nvm
.nvmrc
  • node 20.12.2

  • Check this box to trigger a request for Renovate to run again on this repository

Add Readme file

Should add readme file to document usage of the CLI software

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.