Skelenator NPM

Skelenator

Utility to generate folder/file structure from a JSON or YAML file.

Installation | Usage | Contributing | License

Installation

Global Installation

Global installation is recommended, it allow you to generate and update skeleton from any location without specifying an absolute path.

npm install skelenator --g

Usage

Once the skelenator is installed globally, you can generate the folder/file structure by passing a JSON or YAML file as argument. For e.g.

skelenator component.json

you can pass multiple files for more complex skeleton

skelenator component.json component.yml

component.yml

---
- app/:
  - components/:
    - Header/:
      - styles/:
        - styles.css
      - data/:
        - data.json
      - test/:
        - spec.js
      - assets/
      - index.js
      - README.md

component.json

[
  {
    "app/": [
      {
        "components/": [
          {
            "Header/": [
              {
                "styles/": [
                  "styles.css"
                ]
              },
              {
                "data/": [
                  "data.json"
                ]
              },
              {
                "test/": [
                  "spec.js"
                ]
              },
              "assets/",
              "index.js",
              "README.md"
            ]
          }
        ]
      }
    ]
  }
]

will generate following skeleton

.../app/
.../app/components/
.../app/components/Header/
.../app/components/Header/styles/
.../app/components/Header/styles/styles.css
.../app/components/Header/data/
.../app/components/Header/data/data.json
.../app/components/Header/test/
.../app/components/Header/test/spec.js
.../app/components/Header/assets/
.../app/components/Header/index.js
.../app/components/Header/README.md

Dryrun

It is always recommended to do a dryrun before generating the skeleton, to run skelenator in dryrun mode you need to pass --dryrun. This will not create any file or folder.

skelenator component.json --dryrun

Overwriting

If any of the file already exist, skelenator will not overwrite it. To force overwrite, you need to pass --overwrite. For e.g.

skelenator component.json --overwrite

Contributing

If you also like the idea of creating standard dotfiles, which can be shared with others, and you think you can contribute by improving the currently available dotfiles or adding new ones, please send a pull request.

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.