ui-jar-schematics

Schematics that add an ui-jar project in an Angular workspace for making documentation

Usage no npm install needed!

<script type="module">
  import uiJarSchematics from 'https://cdn.skypack.dev/ui-jar-schematics';
</script>

README

Ui-jar Schematics

1 - Installation

ng add ui-jar-schematics

This will download the collection of schematics and set up an initial ui-jar project automatically :

  • creates a project named 'ui-jar' in the projects directory of the Angular workspace
  • downloads the ui-jar dependency (with the latest version)
  • sets up the project : adds script to package.json file, updates tsconfig.app.json, replaces main.ts and index.html files

This initial project works for the default project created within the Angular workspace by the ng new command (if not skipped with the ng new option : --createApplication=false)

Alternative

If you installed the schematics using

npm i -D ui-jar-schematics

You have to set up the initial ui-jar project by running this command :

ng g ui-jar-schematics:generate-uijar-project [options]

options :

--skipInstall=true|false (default: false)

skip the installation of the needed packages (ui-jar)

2 - Set up an initial ui-jar project

  • creates a project named 'ui-jar' in the projects directory of the Angular workspace
  • downloads the ui-jar dependency
  • sets up the project : adds script to package.json file, updates tsconfig.app.json, replaces main.ts and index.html files
options :

--skipInstall=true|false (default: false)

This initial project works for the default project (if not skipped) created within the Angular workspace by the ng new command

Run the style guide

npm run start:ui-jar

2 - Add configuration for a specific project or library

ng g ui-jar-schematics:add-uijar-doc [options]
  • creates a specific tsconfig.app.json for the project or the library
  • add build configuration is angular.json file corresponding to the new documentation to generate for the project or the library : this will specify the output directory and the tsconfig.app.json that will replace the initial one
  • adds script to package.json file
options :

--project=name (a prompt asks it if not specified (prompt is supported only in Angular 7+))

Run the style guide for the specific project or library

npm run start:ui-jar:{project-name}