{"id":15588578,"url":"https://github.com/aturingmachine/nuxtapose","last_synced_at":"2025-03-29T09:29:00.014Z","repository":{"id":47370711,"uuid":"391453223","full_name":"aturingmachine/nuxtapose","owner":"aturingmachine","description":"CLI for doing boilerplate work in a Nuxt project.","archived":false,"fork":false,"pushed_at":"2021-09-02T04:32:29.000Z","size":1355,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-30T04:21:43.269Z","etag":null,"topics":["boilerplate","cli","developer-tools","nuxt","nuxtjs","vue","workflow"],"latest_commit_sha":null,"homepage":"https://aturingmachine.github.io/nuxtapose/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aturingmachine.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-07-31T20:02:07.000Z","updated_at":"2021-09-02T04:27:28.000Z","dependencies_parsed_at":"2022-08-21T19:20:10.474Z","dependency_job_id":null,"html_url":"https://github.com/aturingmachine/nuxtapose","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aturingmachine%2Fnuxtapose","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aturingmachine%2Fnuxtapose/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aturingmachine%2Fnuxtapose/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aturingmachine%2Fnuxtapose/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aturingmachine","download_url":"https://codeload.github.com/aturingmachine/nuxtapose/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246165712,"owners_count":20734089,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boilerplate","cli","developer-tools","nuxt","nuxtjs","vue","workflow"],"created_at":"2024-10-02T22:40:43.513Z","updated_at":"2025-03-29T09:28:59.996Z","avatar_url":"https://github.com/aturingmachine.png","language":"TypeScript","readme":"[![npm version](https://badge.fury.io/js/nuxtapose.svg)](https://badge.fury.io/js/nuxtapose)\n\n# nuxtapose\n\n_nuxtapose is in alpha and may be unstable or changing_\n\n- [Installation](#installation)\n- [Configuration](#configuration)\n  - [Configuration Options](#configuration-fields)\n- [Global CLI Options](#global-cli-options)\n  - [Logging Levels](#logging-levels)\n- Commands\n  - [Generate](#generate-command)\n- [Roadmap](#roadmap)\n\nnuxtapose is a cli designed to do the repetitive work of Nuxt development for you.\n\n```sh\n# Create a new component file at 'log-details/log-info.vue' and a corresponding spec file\nnuxtapose generate component log-details/log-info\n\n# Generate a new page file at 'pages/faq.vue' and a corresponding spec file\nnuxtapose generate page faq\n\n# Generate a new vuex store file at `store/users.ts` and a corresponding spec file\nnuxtapose generate vuex users\n```\n\n## Installation\n\n```sh\nnpm install -g nuxtapose\n```\n\n## Configuration\n\nnuxtapose can be configured via a `.nuxtaposerc.json` in the projects root directory. nuxtapose will also run a configuration wizard if it is run in a project without a `.nuxtaposerc.json`\n\n### Configuration Fields\n\n```js\n{\n  // Required Configuration\n  \"component\": \"class-based | options-api\",\n  \"vuex\": \"modules | class-based\",\n  \"module\": \"modules\", // More options coming soon (tm)\n\n  // Optional Configuration\n  \"confirmChanges\": \"never | overwrite-only | always\",\n  \"reportLevel\": \"all | completed-only | none\",\n}\n```\n\n- `component`\n  - `class-based`: generate components using the class based pattern\n  - `options-api`: generate components using the options api\n- `vuex`\n  - `modules`: generate store files using GetterTree, ActionTree, and MutationTree\n  - `class-based`: Currently unsupported\n- `module`\n  - `modules`: Generate a store as a module using GetterTree, ActionTree, and MutationTree\n- `confirmChanges` - Default `overwrite-only`\n  - `never`: never ask for confirmation before taking an action\n  - `overwrite-only`: ask for confirmation if the action will overwrite a file\n  - `always`: ask for confirmation before any action\n- `reportLevel` - Default `all`\n  - `all`: include all events in the run report\n  - `completed-only`: only show events for actions that were completed\n  - `none`: do not generate an after run report\n\n## Global CLI Options\n\n### Logging Levels\n\n- `--debug, -d`\n  - increases verbosity of logging\n- `--quiet, -q`\n  - supress all logs and after run reports\n- `--verbose, -v`\n  - equal to  `--debug` and `\"reportLevel\": \"all\"`\n\n## Generate Command\n\nGenerate a new templated file. This is similar to the `ng generate` command.\n\n- [Usage](#generate-usage)\n- [Templates](#generate-templates)\n- [CLI Options](#generate-cli-options)\n\n### Generate Usage\n\n```sh\nnuxtapose generate|g \u003ctemplate-type\u003e \u003coutput-path\u003e\n```\n\n`output-path` should *not* include the base output directory of the template. Output Paths with a trailing slash (i.e. `dir/my-component/`) will create a sub-directory of the same name containing the generated files:\n\n```\ncomponents/\n  - dir/\n    - my-component/\n      - my-component.vue\n      - my-component.spec.ts\n```\n\n### Generate Templates\n\n\u003e nuxtapose currently only supports Typescript projects, Javascript support is coming soon\n\n| template    | output dir      | file type | notes                                                          |\n|-------------|-----------------|-----------|----------------------------------------------------------------|\n| `c\\|component` | `components/`   | vue       |                                                                |\n| `p\\|page`      | `pages/`        | vue       |                                                                |\n| `l\\|layout`    | `layouts/`      | vue       | Adds `layout` suffix to provided name                          |\n| `v\\|vuex`      | `store/`        | TS/JS     |                                                                |\n| `mod\\|module`    | `store/\u003cname\u003e/` | TS/JS     | Generates a file each for getters, setters, actions, and state |\n\n### Generate CLI Options\n\n- `--confirm, -c`\n  - equivalent to using `\"confirmChanges\": \"all\"`\n\n\n## Roadmap\n\nFeatures that I am hoping to implement in the near future:\n\n- custom templates\n- storybook story templating for components\n- javascript templates\n- middleware templates\n- programmatic API","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faturingmachine%2Fnuxtapose","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faturingmachine%2Fnuxtapose","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faturingmachine%2Fnuxtapose/lists"}