@toptal/davinci-syntax

    11.1.4 • Public • Published

    @toptal/davinci-syntax

    Helps to check the style of your code. Provides basic linting, prettier functionality for your js and css code, according to the Frontend Architecture Guidelines.

    Usage

    Use it by installing yarn add @toptal/davinci in your project.

    Init

    Important: If you've bootstrapped your projects by using davinci CLI there is NO NEED to run init in your project because syntax package already set up.

    But if you are using syntax as a standalone package, before using it you have to run

    davinci syntax init

    Under the hood, it will prepare .estlintrc, .eslintignore, .prettierrc, .stylelintrc, .editorconfig files in your project, and set up hooks to check your code on commits.

    Lint

    Code

    To lint your code in the root of your project run

    davinci syntax lint code .

    Options:

    • --check - just checks your code and don't fix it. Useful for CI jobs.

    Styles and styled components

    To lint your styles and styled components in the root of your project run

    davinci syntax lint styles .

    According to the Frontend Architecture Guidelines we expect that all styled components will be at the files styles.ts (or styles.js).

    Alias

    In all the commands you can use davinci-syntax directly if needed, instead of davinci syntax. This is not a recommended way to use davinci, but in very rare cases it might be useful.

    IDE Tooling

    This package can be used directly in your IDE through these extensions

    Keywords

    Install

    npm i @toptal/davinci-syntax

    DownloadsWeekly Downloads

    69,500

    Version

    11.1.4

    License

    ISC

    Unpacked Size

    92.7 kB

    Total Files

    30

    Last publish

    Collaborators

    • talbot