[!IMPORTANT] This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be available through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.

Powerlines - Nx Plugin

A package containing tools for managing a Storm workspace. It includes various Nx generators and executors for common development tasks.

Table of Contents

• Powerlines - Nx Plugin
  • Table of Contents
  • Installing
  • Executors
  • Powerlines Clean Executor
    • Example
    • Options
  • Powerlines Prepare Executor
    • Example
    • Options
  • Powerlines Lint Executor
    • Example
    • Options
  • Powerlines Build Executor
    • Example
    • Options
  • Powerlines Docs Executor
    • Example
    • Options
  • Generators
  • Powerlines Sync Generator
    • Options
  • Building
  • Running unit tests
  • Storm Workspaces
  • Roadmap
  • Support
  • License
  • Changelog
  • Contributing
  • Contributors

This library was generated with Nx.

Installing

Using pnpm:

pnpm add -D @powerlines/nx

npm install -D @powerlines/nx

yarn add -D @powerlines/nx

Executors

The following executors are available in this package to invoke common tasks for the workspace's projects:

Powerlines Clean Executor

A type definition for the Powerlines - Clean executor schema

Example

This executor can be used by executing the following in a command line utility:

nx run my-project:clean

Please note: The clean executor should be included in the desired projects's project.json file.

Options

The following executor options are available:

| Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | outputPath | string | The output path for the build | "dist/{projectRoot}" | | tsconfig | string | The path to the tsconfig file | "{projectRoot}/tsconfig.json" | | mode | "development" | "test" | "production" | The build mode | | | skipInstalls | boolean | Skip installing dependencies during prepare stage | | | logLevel | "error" | "success" | "silent" | "fatal" | "warn" | "info" | "debug" | "trace" | "all" | The log level to use for the build process | |

Powerlines Prepare Executor

A type definition for the Powerlines - Prepare executor schema

Example

This executor can be used by executing the following in a command line utility:

nx run my-project:prepare

Please note: The prepare executor should be included in the desired projects's project.json file.

Options

The following executor options are available:

| Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | outputPath | string | The output path for the build | "dist/{projectRoot}" | | tsconfig | string | The path to the tsconfig file | "{projectRoot}/tsconfig.json" | | mode | "development" | "test" | "production" | The build mode | | | skipInstalls | boolean | Skip installing dependencies during prepare stage | | | logLevel | "error" | "success" | "silent" | "fatal" | "warn" | "info" | "debug" | "trace" | "all" | The log level to use for the build process | | | skipCache | boolean | Skip the cache when building | | | clean | boolean | Automatically clean the project's output artifacts (if required) | |

Powerlines Lint Executor

A type definition for the Powerlines - Lint executor schema

Example

This executor can be used by executing the following in a command line utility:

nx run my-project:lint

Please note: The lint executor should be included in the desired projects's project.json file.

Options

The following executor options are available:

| Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | outputPath | string | The output path for the build | "dist/{projectRoot}" | | tsconfig | string | The path to the tsconfig file | "{projectRoot}/tsconfig.json" | | mode | "development" | "test" | "production" | The build mode | | | skipInstalls | boolean | Skip installing dependencies during prepare stage | | | logLevel | "error" | "success" | "silent" | "fatal" | "warn" | "info" | "debug" | "trace" | "all" | The log level to use for the build process | | | skipCache | boolean | Skip the cache when building | | | clean | boolean | Automatically clean the project's output artifacts (if required) | |

Powerlines Build Executor

A type definition for the Powerlines - Build executor schema

Example

This executor can be used by executing the following in a command line utility:

nx run my-project:build

Please note: The build executor should be included in the desired projects's project.json file.All required options must be included in the options property of the json.

Options

The following executor options are available:

| Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | outputPath | string | The output path for the build | "dist/{projectRoot}" | | tsconfig | string | The path to the tsconfig file | "{projectRoot}/tsconfig.json" | | mode | "development" | "test" | "production" | The build mode | | | skipInstalls | boolean | Skip installing dependencies during prepare stage | | | logLevel | "error" | "success" | "silent" | "fatal" | "warn" | "info" | "debug" | "trace" | "all" | The log level to use for the build process | | | skipCache | boolean | Skip the cache when building | | | clean | boolean | Automatically clean the project's output artifacts (if required) | | | entry * | string | The entry file or files to build | "{sourceRoot}/index.ts" | | skipLint | boolean | Skip the linting process ran prior to the build (if required) | |

Please note: Option names followed by * above are required, and must be provided to run the executor.

Powerlines Docs Executor

A type definition for the Powerlines - Docs executor schema

Example

This executor can be used by executing the following in a command line utility:

nx run my-project:docs

Please note: The docs executor should be included in the desired projects's project.json file.

Options

The following executor options are available:

| Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | outputPath | string | The output path for the build | "dist/{projectRoot}" | | tsconfig | string | The path to the tsconfig file | "{projectRoot}/tsconfig.json" | | mode | "development" | "test" | "production" | The build mode | | | skipInstalls | boolean | Skip installing dependencies during prepare stage | | | logLevel | "error" | "success" | "silent" | "fatal" | "warn" | "info" | "debug" | "trace" | "all" | The log level to use for the build process | | | skipCache | boolean | Skip the cache when building | | | clean | boolean | Automatically clean the project's output artifacts (if required) | |

Generators

The following generators are available with this package to assist in workspace management:

Powerlines Sync Generator

A type definition for the Powerlines - Sync generator's options

Options

The following executor options are available:

| Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | outOfSyncMessage | string | The message to display when the project is out of sync with the legal-message.txt file | "The legal-message.txt file needs to be created" |

Building

Run nx build devkit-nx to build the library.

Running unit tests

Run nx test devkit-nx to execute the unit tests via Jest.

Storm Workspaces

Storm workspaces are built using Nx, a set of extensible dev tools for monorepos, which helps you develop like Google, Facebook, and Microsoft. Building on top of Nx, the Open System provides a set of tools and patterns that help you scale your monorepo to many teams while keeping the codebase maintainable.

Roadmap

See the open issues for a list of proposed features (and known issues).

• Top Feature Requests (Add your votes using the 👍 reaction)
• Top Bugs (Add your votes using the 👍 reaction)
• Newest Bugs

Support

Reach out to the maintainer at one of the following places:

• Contact
• GitHub discussions
• [email protected]

License

This project is licensed under the Apache License 2.0. Feel free to edit and distribute this template as you like.

See LICENSE for more information.

Changelog

This project adheres to Semantic Versioning. Every release, along with the migration instructions, is documented in the CHANGELOG file

Contributing

First off, thanks for taking the time to contribute! Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please try to create bug reports that are:

• Reproducible. Include steps to reproduce the problem.
• Specific. Include as much detail as possible: which version, what environment, etc.
• Unique. Do not duplicate existing opened issues.
• Scoped to a Single Bug. One bug per report.

Please adhere to this project's code of conduct.

You can use markdownlint-cli to check for common markdown style inconsistency.

Contributors

Thanks goes to these wonderful people (emoji key):

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

Storm Software is an open source software development organization and creator of Acidic, StormStack and StormCloud.

Our mission is to make software development more accessible. Our ideal future is one where anyone can create software without years of prior development experience serving as a barrier to entry. We hope to achieve this via LLMs, Generative AI, and intuitive, high-level data modeling/programming languages.

Join us on Discord to chat with the team, receive release notifications, ask questions, and get involved.

If this sounds interesting, and you would like to help us in creating the next generation of development tools, please reach out on our website or join our Slack channel!