Skip to content

art-ws/ngx-ws

Repository files navigation

🚀 ngx-ws

Generate angular.json from modular, human-friendly definitions.

Easily split a large angular.json into modular, project-local files using the power of JSON References, with the convenience of YAML and JSON5 formats.


🛠️ How It Works

  1. Install ngx-ws globally (using your preferred package manager):
npm install -g ngx-ws
# or
pnpm add -g ngx-ws
# or
yarn global add ngx-ws
  1. Navigate to your Angular project directory (where angular.json is located):
cd your-angular-project
  1. Initialize modular configuration files from your existing angular.json:
ngx-ws --build

This generates angular-workspace.yaml and angular-project.yaml files.

  1. Edit your configuration in the new YAML files.
    You can now manage your workspace and project settings in a modular, human-friendly format.

  2. Regenerate angular.json after making changes:

ngx-ws -v

This will update angular.json based on your YAML definitions.


Tip:
Once set up, you can focus on editing angular-workspace.yaml and angular-project.yaml.
Let ngx-ws handle the generation of angular.json for you!

✨ Features


🧩 Example

See the ngx-ws-example repository.
Pay special attention to angular-workspace.yaml and angular-project.yaml.


⚙️ Options

Option Alias Description
--build Build files from angular.json
--deps Update package.json with project-specific dependencies
--debug Enable debug mode (retain temporary files)
--dry-run Preview changes without writing files
--verbose -v Enable verbose output
--version Print version

About

ngx-ws

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •