Standards

Common standards/styles configs for Sous Chef JS/TS projects

Developing

Install dependencies:

nvm use
npm install

Usage

Start by adding our Typescript eslint configuration to eslint.config.js:

npm install -D @thesouschef/eslint-config

For pure typescript projects:

import config from "@thesouschef/eslint-config";

export default config;

For including the configuration along with other configurations:

import config from '@thesouschef/eslint-config';

export default [...config, <other rules>];

For React projects:

npm install -D @thesouschef/eslint-config-react

import config from "@thesouschef/eslint-config";
import react from "@thesouschef/eslint-config-react";

export default [...config, ...react];

For Next.JS projects:

npm install -D @thesouschef/eslint-config-next

import config from "@thesouschef/eslint-config";
import react from "@thesouschef/eslint-config-react";
import next from "@thesouschef/eslint-config-next";

export default [...config, ...react, ...next];

For React Native projects:

NOTE: Under construction until @react-native/eslint-config adds support for flat config

npm install -D @thesouschef/eslint-config-react-native

import config from "@thesouschef/eslint-config";
import reactNative from "@thesouschef/eslint-config-react-native";

export default [...config, ...reactNative];

Using our Prettier config:

npm install -D @thesouschef/prettier

Create a .prettierrc.js file with the following contents:

export * from "@thesouschef/prettier";

If you wish to override any rules, then use the rules as such:

import rules from '@thesouschef/prettier';

export default {
    ...rules,
    <your overrides>
};

Contributing

This repo uses nx to manage the various projects and changesets to manage deployments.