\n\n\n\n# Neo Angular Schematics\n\nAngular schematics for a faster and scalable code generation.\n\n# WORK IN PROGRESS - USE WITH CAUTION\n\n## Usage\n\n```shell\n# create new angular/cli workspace\nng new ng-workspace --create-application=false\ncd ng-workspace\n\n# add neo schematics\n# - this will add @neox/schematics to devDependencies\n# - adds @neox/schematics as cli/defaultCollection (angular.json)\n# - sets quotes to double (.editorconfig)\nng add @neox/schematics\n\n# create new angular/cli project\nng generate application app-one -t -p=ao\n# or\nng generate application app-one\nng generate neo-init --inlinetemplate --prefix=ao\n\nng generate neo-base\n\nng generate neo-module routes/main/main routing\n\nng generate neo-module routes/main/layouts/main layout\n\n# add eslint (for more details: https://github.com/angular-eslint/angular-eslint)\nng add @angular-eslint/schematics\n\n# change cli default schematics collection (angular.json/cli.defaultCollection)\n```\n\n---\n---\n\n\nAs of Version 11.2.5 this project version is synced with the current angular version generated by the cli.\n\n> I try my best, otherwise raise an issue or send me an email. Thank you! :)\n\n---\n\n# Table of Contents\n\n- [WORK IN PROGRESS - USE WITH CAUTION](#work-in-progress---use-with-caution)\n - [Usage](#usage)\n- [Status](#status)\n- [Quick start](#quick-start)\n- [Usage](#usage-1)\n- [Schematics](#schematics)\n - [Neo-Init](#neo-init)\n - [Neo-Styles](#neo-styles)\n - [Neo-Base](#neo-base)\n - [Neo-Module](#neo-module)\n - [Neo-Component](#neo-component)\n - [Neo-Service](#neo-service)\n - [Neo-Fontawesome](#neo-fontawesome)\n - [Neo-Stylelint](#neo-stylelint)\n - [Neo-CI](#neo-ci)\n - [License](#license)\n\n# Status\n\n[](https://www.npmjs.com/package/@neox/schematics)\n[](#license)\n\n# Quick start\n\nAdd to angular cli project\n\n- Add with [npm](https://www.npmjs.com/): `npm install --save-dev @neox/schematics`\n\nTo use **@neox/schematics** as the default collection in your Angular CLI project, add it to your **angular.json**:\n\n```shell\nng config cli.defaultCollection @neox/schematics\n```\n\n# Usage\n\n```shell\n# create new angular/cli project with inline-templates, scss & no routing\nng new example -p ex -t --style=scss\ncd example\n\n# add neox/schematics\nnpm install --save-dev @neox/schematics\n\n# add neox/schematics as defaultCollection\nng config cli.defaultCollection @neox/schematics\n\n# initialize neo project and add sytlelint\nng g neo-init\nnpm run add-stylelint\n\n# add folder structure\nng g neo-base\n\n# add new module (eg user) to routes\nng g neo-module routes/user\n# import UserModule in routes.module.ts\n# import UserViewComponent in routes.ts\n\nng serve\n\n# --- optional ---\n# add fontawesome\nng g neo-fontawesome\nnpm run add-fontawesome \n\n# add fontawesome pro\nng g neo-fontawesome --token=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\nnpm run add-fontawesome \n```\n\n# Schematics\n\n## Neo-Init\n\nAdds Neo configuration\n\n- Runs neo styles schematic\n- angular.json\n - Sets prefix\n - style: scss\n - inlineTemplate: true\n - stylePreprocessorOptions -> includePaths: [\"src/styles/scss\"]\n- tslint.json\n - quotemarks: flags.quote\n - no-inferrable-types: [..., \"ignore-properties\"]\n - variable-name.options: [..., \"allow-leading-underscore\"]\n- tsconfig.json\n - adds path links for @assets, @core, @layout, @routes, @shared and @env\n- package.json\n - adds prod script: ng build --prod\n- Removes app.component.html\n- Adds core-, layout-, routes-module imports to app.module.ts\n- Adds router-outlet to app.component.ts\n- Applys quote to .editorconfig\n\n\n### Usage\n\n```shell\nng g ni\n```\n\n\n### Flags\n\n- `prefix(string)` - The prefix to apply to the generated classes\n- `quotes(\"double\"|\"single\")` - used quotation (default: \"double\")\n- `styles(boolean)` - run neo styles schematic (default: true)\n- `stylelint(boolean)` - run neo stylelint schematics (default: true)\n- `project(string)` - The name of the project (NOT implemented yet)\n\n## Neo-Styles\n\nAdds Neo styles folder structure\n\n\n### Usage\n\n```shell\nng g nst\n```\n\n\n### Flags\n\n- `project(string)` - The name of the project (NOT implemented yet)\n\n## Neo-Base\n\nCreates Neo application structure\n\n```shell\napp\n└─ core\n└─ layout\n└─ routes\n└─ shared\n```\n\n\n### Usage\n\n```shell\nng g nb\n```\n\n\n### Flags\n\n- `project(string)` - The name of the project (NOT implemented yet)\n\n## Neo-Module\n\nCreates a Neo Module\n\n```shell\nneo\n│ neo.module.ts\n│\n└─ components\n│ │ index.ts\n│\n└─ containers\n│ │ index.ts\n│\n└─ views\n│ │ index.ts\n│\n└─ services\n │ index.ts\n │ neo-sandbox.service.ts\n │ ...\n │\n └─ util\n │ index.ts\n │\n └─ neo\n │ neo-util.service.ts\n │ ...\n\n```\n\n\n### Usage\n\n```shell\nng g nm routes/auth\n```\n\n\n### Flags\n\n- `name(string)` - path/name of the module (argv-index: 0)\n- `type` - type of the created module (argv-index: 1)\n - `\"\"`: creates name module with above folder structure\n - `core`: creates core module\n - `layout`: creates layout module\n - `routes`: creates routes module\n - `shared`: creates shared module\n- `project(string)` - The name of the project\n\n## Neo-Component\n\nCreates a Neo Component\n\n\n### Usage\n\n```shell\nng g nc routes/auth/components/user-input\n```\n\n```shell\nng g nc routes/auth/views/auth --type=view --template='This is an awesome view!'\n```\n\n```shell\nng g nc routes/auth/containers/login container auth --destroyable\n```\n\n\n### Flags\n\n- `name(string)` - path/name of the component (argv-index: 0)\n- `type` - type of the created component (argv-index: 1)\n - `view`: creates a view component\n - `container`: creates a container\n - `component`: creates a simple component with structural comments\n- `sandbox(string)` - sandbox name which will be automatically imported (argv-index: 2)\n- `forms(boolean)` - Adds FormBuilder import and constructor definition\n- `renderer(boolean)` - Adds Renderer2 import and constructor definition\n- `router(boolean)` - Adds Router import and constructor definition\n- `destroyable(boolean)` - Adds destroyed subject for simpler unsubscribing from observable\n- `template(string)` - inline template string\n- `project(string)` - The name of the project\n\n## Neo-Service\n\nCreates a Neo service\n\n\n### Usage\n\n```shell\nng g ns core/api/user api\n```\n\n\n### Flags\n\n- `name(string)` - path/name of the service (argv-index: 0)\n- `type` - type of the created service (argv-index: 1)\n - `\"\"`: creates name.service in folder name\n - `api`: creates name-api.service in folder name\n - `sandbox`: creates name-sandbox.service and adds name-util.service to its imports\n - `util`: creates name-util.service in folder util/name\n- `project(string)` - The name of the project\n\n## Neo-Fontawesome\n\nAdds Fontawesome\n\n\n### Usage\n\n```shell\nng g nf --token=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx --brands\nnpm run add-fontawesome\n```\n\n\n### Flags\n\n- `token(string)` - Fontawesome Pro token for .npmrc generation\n- `solid(boolean)` - Adds solid icons to 'add-fontawesome' script (default: true)\n- `regular(boolean)` - Adds regular icons to 'add-fontawesome' script (default: true)\n- `brands(boolean)` - Adds brands icons to 'add-fontawesome' script (default: false)\n- `light(boolean)` - Adds light icons to 'add-fontawesome' script (default: true)\n- `duotone(boolean)` - Adds duotone icons to 'add-fontawesome' script (default: true)\n- `skipImport(boolean)`- Skips module import to shared.module (default: false)\n\n## Neo-Stylelint\n\nAdds Stylelint\n\n\n### Recommendation\n\nadd stylelint vscode extension for stylelint highlighting\n\n\n### Usage\n\n```shell\nng g nslint\nnpm run add-stylelint\n# launching stylelint once\nnpm run stylelint-scss\n```\n\n## Neo-CI\n\nAdds GitLab CI configuration template with nginx config and dockerfile \n\n\n### Usage\n\n```shell\nng g nsci\n```\n\n## License\n\n\n\n- **[MIT license](http://opensource.org/licenses/mit-license.php)**","readmeFilename":"README.md"}
![](\"https://i.imgur.com/LQj7j89.png\")
\n \n