Détail du package

@design-systems/lint

intuit5.1kMIT4.15.4

The lint command for @design-systems-cli

readme

A CLI toolbox for creating design systems in minutes

Uses: Typescript, CSS, styled-components support

Outputs: CJS and MJS

No tooling configuration required

CircleCI npm npm Auto Release


Overview

Design-systems-cli is basically a Create React App for design systems.

The main benefit it brings you as a developer is time savings. Setting up all of the monorepo, storybook, and build tools for a design system takes over a week if you piece it together yourself. You can do it with this project in minutes.

Features

:star: Scaffold components and entire design systems

:star: Build your components for multiple outputs (cjs and esm)

:star: Write styles with styled-components or css-modules

:star: Craft excellent components using Storybook

:star: Let component consumer try your components with playroom

:star: Testing and linting support

:star: Typescript supported out of the box

:star: Track the size of your components and debug the changes

For the full documentation, go here.

Installation

Ensure you have the following softwares installed:

To get started:

To get set up, fork and clone the project then run the following command:

yarn && yarn start

Creating a new Plugin

To scaffold a new plugin inside this repo run the following command:

yarn run create:plugin "my plugin"

Contributing

Feel free to open an issue or a pull request!

Make sure to read our code of conduct.

We actively welcome pull requests. Learn how to contribute.

Contributors ✨

Thank you to all these wonderful people (emoji key):


Adam Dierkens

💻 🎨 🤔 📖 ⚠️

Andrew Lisowski

💻 🎨 📖 🤔 🚇 ⚠️

Tyler Krupicka

💻 📖 ⚠️

Kendall Gassner

💻 📖 ⚠️

Kelly Harrop

🎨

Peter Mikitsh

📖

WhiteSource Renovate

💻 ⚠️

mishavp2001

💻

Raj Vasikarla

💻 📖 ⚠️

Brandon Orther

📖 💻

alan-cruz2

💻

hainessss

💻

Athitya Kumar

💻

Jason Rundell (he/him)

📖 ⚠️ 💻

Reuben

📖

my99N

📖 ⚠️ 💻

anjaliguptaz

📖

chaopan

⚠️

Talor Anderson

💻 📖 ⚠️

Spencer Hamm

💻 📖 ⚠️

Adil Malik

⚠️

Salil Cuncoliencar

📖 ⚠️ 💻

Gaurav Kesarwani

📖 ⚠️ 💻

Nicolas Hoizey

📖

Harris Borawski

💻

Sean Powell

💻

melindali255

📖 ⚠️ 💻

Yucho Ho

💻

Jeremiah Zucker

⚠️

Abd El-Ghazali

📖 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

changelog

v2.15.2 (Tue Mar 09 2021)

🐛 Bug Fix

Authors: 1


v2.15.0 (Mon Mar 08 2021)

:tada: This release contains work from a new contributor! :tada:

Thank you, Gaurav Kesarwani (@GauravKesarwani), for all your work!

🚀 Enhancement

🐛 Bug Fix

🔩 Dependency Updates

Authors: 3


v2.14.0 (Fri Mar 05 2021)

:tada: This release contains work from new contributors! :tada:

Thanks for all your work!

:heart: Vitor Freitas Buchalla (@vfreitas-)

:heart: Salil Cuncoliencar (@salilbc)

🐛 Bug Fix

🔩 Dependency Updates

📝 Documentation

Authors: 5


v2.12.3 (Thu Mar 04 2021)

🏠 Internal

  • feat: Integration Testing #216 (raj_vasikarla@intuit.com)

Authors: 1


v2.11.0 (Thu Jan 07 2021)

🚀 Enhancement

🐛 Bug Fix

Authors: 1


v2.2.2 (Mon Sep 14 2020)

🐛 Bug Fix

Authors: 1


v2.2.1 (Mon Sep 14 2020)

🐛 Bug Fix

Authors: 1


v2.1.0 (Mon Sep 14 2020)

:tada: This release contains work from a new contributor! :tada:

Thank you, Athitya Kumar (@athityakumar), for all your work!

🚀 Enhancement

🐛 Bug Fix

  • Fixes linting issue to preferably not use 'any' type (@athityakumar)
  • Changes docstring and default value to match eslint (@athityakumar)
  • Starts adding support for --max-warnings flag in lint command (@athityakumar)

Authors: 1


v2.0.2 (Mon Aug 31 2020)

🐛 Bug Fix

🔩 Dependency Updates

Authors: 3


v2.0.0 (Fri Aug 14 2020)

Release Notes

From #365

WDIO Breaking changes:

  • host -> hostname in proof.config.js
  • Change all tests to use wdio updated APIs
  • Removal of assert from proof. Consumer provides their own assertion library now

From #270

This release upgrades storybook from 5.3 to 6.0. This release will deprecate the old storybook configuration format in favor of the new format.

This allows use to package all of our storybook configuration into a preset that you can use like any other storybook preset. Instead of ds-cli managing a .storybook folder for you, you now have full control (much like with all the other tools).

Storybook Configuration Update Guide

If you have no .storybook folder currently, create one, then fill it with the following.

.storybook/main.js:

module.exports = {
  presets: ["@design-systems/storybook/preset"]
};

.storybook/preview.js:

import * as dsPreview from "@design-systems/storybook/preview";

export const decorators = [...dsPreview.decorators];

export const parameters = {
  ...dsPreview.parameters,
};

If you already have a .storybook folder please read through storybook's migration guide.


💥 Breaking Change

🚀 Enhancement

🐛 Bug Fix

🔩 Dependency Updates

Authors: 5


v1.10.0 (Tue Jun 09 2020)

:tada: This release contains work from a new contributor! :tada:

Thank you, WhiteSource Renovate (@renovate-bot), for all your work!

🔩 Dependency Updates

Authors: 2


v1.7.2 (Fri May 15 2020)

🐛 Bug Fix

Authors: 1


v1.5.1 (Mon Apr 27 2020)

🏠 Internal

Authors: 1


v1.4.7 (Tue Mar 24 2020)

:tada: This release contains work from a new contributor! :tada:

Thank you, WhiteSource Renovate (@renovate-bot), for all your work!

🔩 Dependency Updates

Authors: 2


v1.2.0 (Wed Jan 22 2020)

🐛 Bug Fix

Authors: 1


v1.1.0 (Thu Jan 16 2020)

🐛 Bug Fix

Authors: 1


v0.74.1 (Tue Jan 07 2020)

⚠️ Pushed to master

  • @design-systems/cli-utils, @design-systems/cli, @design-systems/core, @design-systems/create, @design-systems/eslint-config, @design-systems/load-config, @design-systems/plugin, @design-systems/stylelint-config, @design-systems/build, @design-systems/bundle, @design-systems/clean, @design-systems/create-command, @design-systems/dev, @design-systems/lint, @design-systems/playroom, @design-systems/proof, @design-systems/size, @design-systems/storybook, @design-systems/test, @design-systems/update

Authors: 1