atomic-bomb v5.0.0

Atomic Bomb

This commandline tool creates boilerplate atomic design components for React apps.

IMPORTANT This tool is for educational purposes only.

UPDATE VERSION 5.x.x (experimental)

• Added extension to .atomic-bomb config
• Creates a index.<ext> file for each atomic-dir, so you can (for example) use:

import { Label, Logo } from '../atoms'

UPDATE VERSION 4.x.x

• Added scss flag to .atomic-bomb config to control if scss files are generated.
• Automatically creates a GitHub workflow file for converting TODO's to issues
• Gets valid platforms from template repository
• Writes configuration to .atomic-bomb file in the project-root
• Reads configuration from .atomic-bomb where you can manually set search, platform and destination-directory.

Install

npm install --global atomic-bomb
# Or in your project
npm install --save-dev atomic-bomb
yarn add -D atomic-bomb

Usage:

atomic-bomb --platform react --type atom|molecule|organism|template|page --name [NAME](,[NAME],[NAME])  

--platform can be extended. Please head over to Templates and open a pull request if you want to contribute to more templates. There is a list of supported platforms in the README.

Example

atomic-bomb --platform react --type atom --name Label
atomic-bomb --platform react --type molecule --name Header

Add multiple

atomic-bomb --platform react --type atom --name Label,Button,Input

dot-file

atomic-bomb creates a dot-file (.atomic-bomb) in the root of your project. You can configure the defaults in this file so you can omit the platform definition. You can also modify the base location of your atoms, molecules etc. directories. Default content:

{
  "search": "react",
  "extension": "js | jsx | ts | tsx",
  "platform": "react",
  "destination": "src/components",
  "scss": true
}

• search: package to search for in package.json to determine if atomic-bomb can be used
• extension: Add the extension you want your files to have (defaults to .js)
• platform: shorthand for the --platform flag
• destination: directory where the atomic-dirs are put.
• scss: if an _index.scss in each atomic-dir should be created.

Shorthand

atomic-bomb --name Label

Defaults to --platform react (platform in the .atomic-bomb-file) and --type atom

Output (React)

[PROJECT_ROOT]/src/components
├── atoms
│   ├── Label
│   │   ├── Label.js
│   │   ├── Label.stories.js
│   │   ├── Label.test.js
│   │   ├── _Label.style.scss
│   │   ├── _index.scss
│   │   └── index.js
│   └── _index.scss
└── molecules
    ├── Header    
    │   ├── Header.js
    │   ├── Header.stories.js
    │   ├── Header.test.js
    │   ├── _Header.style.scss
    │   ├── _index.scss
    │   └── index.js
    └── _index.scss