# @gen-codes/cli > This package is the console interface of gen.codes metaprogramming framework. Latest version **1.2.3** (published 2020-01-28) · MIT license · 0 weekly downloads ## Install ```sh npm install @gen-codes/cli pnpm add @gen-codes/cli yarn add @gen-codes/cli bun add @gen-codes/cli ``` Provides the commands `gen`, `gencodes`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.2.3 | | Published | 2020-01-28 | | First published | 2020-01-04 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=8 | | Dependencies | 16 | | Unpacked size | 221.9 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | Maintainers | gen-codes | ## Links - npm: https://www.npmjs.com/package/@gen-codes/cli - npm.io page: https://npm.io/package/@gen-codes/cli ## Dependencies (16) - [ui](https://npm.io/package/ui.md) ^0.2.4 - [npm](https://npm.io/package/npm.md) ^6.13.6 - [url](https://npm.io/package/url.md) ^0.11.0 - [open](https://npm.io/package/open.md) ^7.0.0 - [carlo](https://npm.io/package/carlo.md) ^0.9.46 - [pastel](https://npm.io/package/pastel.md) 1.0.3 - [semver](https://npm.io/package/semver.md) ^7.1.1 - [request](https://npm.io/package/request.md) ^2.88.0 - [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0 - [omelette](https://npm.io/package/omelette.md) ^0.4.12 - [appdirectory](https://npm.io/package/appdirectory.md) ^0.1.0 - [@gen-codes/ink-cli](https://npm.io/package/@gen-codes/ink-cli.md) ^1.2.0 - [@gen-codes/compiler](https://npm.io/package/@gen-codes/compiler.md) ^1.1.2 - [@gen-codes/ink-schema-form](https://npm.io/package/@gen-codes/ink-schema-form.md) ^1.2.2 - [@gen-codes/use-carlo-react-hook](https://npm.io/package/@gen-codes/use-carlo-react-hook.md) ^1.1.0 - [@gen-codes/carlo-editor-cli-plugin](https://npm.io/package/@gen-codes/carlo-editor-cli-plugin.md) ^1.2.0 ## Recent versions - 1.2.3 (latest) — 2020-01-28 - 1.2.2 — 2020-01-16 - 1.2.1 — 2020-01-16 - 1.2.0 — 2020-01-16 - 1.1.4 — 2020-01-04 - 1.1.3 — 2020-01-04 - 1.1.2 — 2020-01-04 - 1.1.1 — 2020-01-04 - 1.1.0 — 2020-01-04 - 1.0.9 — 2020-01-04 - 1.0.8 — 2020-01-04 - 1.0.7 — 2020-01-04 - 1.0.6 — 2020-01-04 - 1.0.5 — 2020-01-04 - 1.0.4 — 2020-01-04 ## README # @gen-codes/cli This package is the console interface of gen.codes metaprogramming framework. ## Features - Use publicly available code generators - Create code generators ## Install ```bash $ npm i -g @gen-codes/cli ``` ## Run ### Generate a module's file ```bash $ gen run -t @gen-codes/react/componentDoc.js ``` Choose the location where the generated file will be saved. Then fill in the form with the required data. ### Generate based on a module schema model ```bash $ gen run -m @gen-codes/react/component ``` This will bring a dialog to choose the location where associated files will be saved. After that input the required data. ### Generate using a project filetree. ```bash # from local filetree $ gen run -f ./gen.filetree.json # or from a published project module $ gen run -f @gen-codes/mern-app ``` ## Embed it on a project Navigate to your project root folder you want to bootstrap with gen.codes and run: ```bash $ gen init . ``` This will open a form that will guide you through the configuration. The folders `.gen/templates`, `.gen/templates/.partials` and `.gen/schema` will be created. The `schema` folder contains the data structure, restrictions and automations. The `templates` folder contains files with template code dependent on schema models and custom inputs. ### Install generators You can install generators from repo.gen.codes ```bash # locally if initialized $ gen install @gen-codes/react @digigov/material-ui # globally $ gen install -g @gen-codes/react @digigov/material-ui ``` You can also search and install ```bash $ gen search ``` This will bring up the search and install interface ## Generating Generate based on a known gen run if the generator doesn't exist locally it will try to fetch it from gen-codes store. To choose from installed generators run: gen run ## Creating generators ### Module dependencies gen install ### Javascript dependencies gen npm install ### File Templates Any file you create in the `templates` folder is a file template. You can specify information and the required arguments in the head of the file using this syntax: ``` --( name: element description: Create a react component with material-ui attributes: - ref: Element )-- ``` ### Partial Templates Create a folder `template/.partials` and add the code you want to reuse. You can call a partial from a file template using this syntax: ``` {> partial-name arg1=data1 arg2=data2} ``` ### Extension Templates You must specify a hook in the original template file using this syntax: ``` {>= extend-config} ``` and then on the plugin or connector create the folder `template/.extensions`. In this folder create a file with name `extend-config` and add the code which extends the original template file. ### Filetree Templates example ```js export default { _variables: { mainClientFile: "client/main.js", mainServerFile: "server/server.js", webpackServerConfig: "webpack.config.server.js", webpackClientConfig: "webpack.config.client.js" }, "{{app.name}}":{ server: { models: { "{{model.name in app.models[]}}.model.js": { _template: "mongooseSchema" } }, helpers: { "{{helper.name in app.helpers}}.js":{ _template: "javascript/function" } }, routes: { "{{model.name in app.models[]}}.routes.js": { _template: "routes", _context: { routes: "model.routes", prefix: "model.name" } } }, "devBundle.js": { _template: "devBundle", _context: { webpackClientConfig: "var(webpackClientConfig)" } }, "server.js": { _template: "server.js" } }, ".babelrc": { _template: "babelrc", }, "nodemon.json": { _template: "nodemon", _context: { webpackServerConfig: "var(webpackServerConfig)" } }, "var(webpackClientConfig)": { _template: "config.client", _context: { mainFile: "var(mainClientFile)" } }, "webpack.config.client.production.js": { _template: "config.client.production", _context: { mainFile: "var(mainClientFile)" } }, "var(webpackServerConfig)": { _template: "config.server", _context: { mainFile: "var(mainServerFile)" } } } } ``` ### Template helpers Create a template helper function in the `helpers` folder. You can't export default. Only named exports is allowed. ```js export function helperName(arg1,arg2){ // do something with args return something } ``` ### Custom Syntax You can add a custom template syntax by specifying a regex transformation. Create a `.transformations.js` file and export an array with objects like this: ```js { regex: /{{for (.*?) in (.*?)}}/g, expression: `{{#each $2 "$2.$1" as |$1|}}`, closingRegex: /{{\/for}}/g, closingExpression: `{{/each}}` } ``` The expression must be a handlebars expression. ## Extending and combining generators To combine a generator create a connector. ### Data rules ### Hooks You can run custom transformations after the code has been generated. For example you mhy want to run a linter or a beautifier. Create the folder `hooks` and the file `index.js` where you export the order in which the hooks will run. The create files named after the the hooks before. From there export a default function that takes as input the code and returns the transformed code or throws an error. ### Loops You can loop a filtered array using the syntax that `json-query` npm package uses. Example: ``` {{for model in models[type='Account']}} const {{model.name}} = new Account() {{/for}} ``` ### Conditionals You can use normal javascript in if statements like below: ``` {{if model.type === 'Account' && model.name.startsWith('admin')}} //{{model.name}} is an admin account {{/if}} ``` --- _Source: https://npm.io/package/@gen-codes/cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._