lockblocks

React Kindling

This header will contain a brief description of the project.

Documentation

Read the official documentation.

👁️ Live Demo

Overview

This section will contain an overview so people can have a high-level understanding of the project.

Features include:

• 🚀 List your features, use fun emojis
  • Give a little more info on each feature or mention benefits.

Installation

npm i react-kindling

Quick Start

This section will contain a copy/paste example so people can get started quickly.

import { ExampleComponent } from "react-kindling";

<ExampleComponent text="Example Component" />

lockblocks.yml

version: 1
verboseMode: true
updateJson:
  - path: package.json
    root:
      merge: false
      fill: false
      prune: false
      replace: false
    renameFields:
      - from: oldName
        to: newName
    updateFields:
      - key: scripts
        merge: true
      - key: dependencies
        merge: true
      - key: devDependencies
        merge: true
    deleteFields:
      - scripts.remove
updateYaml:
  - path: settings/settings.yml
    root:
      fill: true
    renameFields:
      - from: oldName
        to: newName
      - from: nestedObject.renameMe
        to: newNestedObject.renameMe
      - from: nonExistent
        to: nonExistent2
    updateFields:
      - key: updateMe
        merge: true
    deleteFields:
      - deleteMe
replaceDirectories:
  - target: core
excludePaths:
  - .cache
  - .git
  - .github
  - node_modules
  - public
  - static
replaceFiles:
  - target: .node-version
fillFiles:
  - target: core-sync
  - target: settings/fill.yml
  - target: important-config.json
  - target: already-present-config.json
renameFiles:
  - from: old-named-config.json
    to: renamed-config.json
  - from: old-named-dir
    to: renamed-dir
deleteFiles:
  - delete.me
  - core-sync/delete-2.also.me

TypeScript

Type definitions have been included for TypeScript support.

Logo Attribution

Logo graphics by Twemoji, licensed under CC-BY 4.0. Favicon by favicon.io.

Contributing

Open source software is awesome and so are you. 😎

Feel free to submit a pull request for bugs or additions, and make sure to update tests as appropriate. If you find a mistake in the docs, send a PR! Even the smallest changes help.

For major changes, open an issue first to discuss what you'd like to change.

See Kindling for npm script documentation.

⭐ Found It Helpful? Star It!

If you found this project helpful, let the community know by giving it a star: 👉⭐

MIT License

Copyright © 2020 Justin Mahar https://github.com/justinmahar

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.