-
-
Notifications
You must be signed in to change notification settings - Fork 102
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(nuxt): add first alpha version plugin for nuxt
- Loading branch information
1 parent
af90183
commit 94136e0
Showing
85 changed files
with
4,465 additions
and
120 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -35,6 +35,8 @@ npm-debug.log | |
yarn-error.log | ||
testem.log | ||
/typings | ||
/.yarn | ||
/.yarnrc | ||
|
||
# System Files | ||
.DS_Store | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
## @nxext/nuxt:build | ||
|
||
Nuxt build | ||
|
||
Options can be configured in the 'project.json' when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets. | ||
|
||
### Options | ||
|
||
#### debug | ||
|
||
Default: `false` | ||
|
||
Type: `boolean` | ||
|
||
At the moment, it prints out hook names and timings on the server, and logs hook arguments as well in the browser. | ||
|
||
#### dev | ||
|
||
Default: `false` | ||
|
||
Type: `boolean` | ||
|
||
Whether Nuxt is running in development mode. | ||
|
||
#### outputPath | ||
|
||
Type: `string` | ||
|
||
The output path of the generated files. | ||
|
||
#### ssr | ||
|
||
Type: `boolean` | ||
|
||
Whether to enable rendering of HTML - either dynamically (in server mode) or at generate time. If set to false generated pages will have no content. | ||
|
||
## @nxext/nuxt:serve | ||
|
||
Nuxt dev server | ||
|
||
Options can be configured in the 'project.json' when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets. | ||
|
||
### Options | ||
|
||
#### debug | ||
|
||
Default: `false` | ||
|
||
Type: `boolean` | ||
|
||
At the moment, it prints out hook names and timings on the server, and logs hook arguments as well in the browser. | ||
|
||
#### dev | ||
|
||
Default: `true` | ||
|
||
Type: `boolean` | ||
|
||
Whether Nuxt is running in development mode. | ||
|
||
#### host | ||
|
||
Type: `string` | ||
|
||
Dev server listening host. | ||
|
||
#### port | ||
|
||
Default: `3000` | ||
|
||
Type: `number` | ||
|
||
Dev server listening port | ||
|
||
#### ssr | ||
|
||
Default: `true` | ||
|
||
Type: `boolean` | ||
|
||
Whether to enable rendering of HTML - either dynamically (in server mode) or at generate time. If set to false generated pages will have no content. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
## @nxext/nuxt:application | ||
|
||
Create a Nuxt application. | ||
|
||
### Usage | ||
|
||
```bash | ||
nx generate application ... | ||
``` | ||
|
||
```bash | ||
nx g app ... # same | ||
``` | ||
|
||
By default, Nx will search for `application` in the default collection provisioned in nx.json. | ||
|
||
You can specify the collection explicitly as follows: | ||
|
||
```bash | ||
nx g @nxext/nuxt:application ... | ||
``` | ||
|
||
Show what will be generated without writing to disk: | ||
|
||
```bash | ||
nx g application ... --dry-run | ||
``` | ||
|
||
### Options | ||
|
||
#### name (_**required**_) | ||
|
||
Type: `string` | ||
|
||
#### directory | ||
|
||
Type: `string` | ||
|
||
A directory where the project is placed | ||
|
||
#### e2eTestRunner | ||
|
||
Default: `cypress` | ||
|
||
Type: `string` | ||
|
||
Possible values: `cypress`, `playwright`, `none` | ||
|
||
Test runner to use for end to end (E2E) tests. | ||
|
||
#### inSourceTests | ||
|
||
Default: `false` | ||
|
||
Type: `boolean` | ||
|
||
When using Vitest, separate spec files will not be generated and instead will be included within the source files. Read more on the Vitest docs site: https://vitest.dev/guide/in-source.html | ||
|
||
#### linter | ||
|
||
Default: `eslint` | ||
|
||
Type: `string` | ||
|
||
Possible values: `eslint`, `none` | ||
|
||
The tool to use for running lint checks. | ||
|
||
#### rootProject (**hidden**) | ||
|
||
Default: `false` | ||
|
||
Type: `boolean` | ||
|
||
Create a application at the root of the workspace | ||
|
||
#### skipFormat | ||
|
||
Default: `false` | ||
|
||
Type: `boolean` | ||
|
||
Skip formatting files. | ||
|
||
#### skipNxJson | ||
|
||
Default: `false` | ||
|
||
Type: `boolean` | ||
|
||
Skip updating `nx.json` with default options based on values provided to this app. | ||
|
||
#### tags | ||
|
||
Alias(es): t | ||
|
||
Type: `string` | ||
|
||
Add tags to the application (used for linting). | ||
|
||
#### unitTestRunner | ||
|
||
Default: `none` | ||
|
||
Type: `string` | ||
|
||
Possible values: `vitest`, `none` | ||
|
||
Test runner to use for unit tests. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
Add this plugin to an Nx workspace: | ||
|
||
```bash | ||
#yarn | ||
yarn add -D @nxext/nuxt | ||
``` | ||
|
||
```bash | ||
#npm | ||
npm install -D @nxext/nuxt | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Overview of the Nuxt plugin | ||
|
||
::: warning | ||
This plugin is in alpha state. It is not feature complete yet and not ready for production. | ||
::: | ||
|
||
[@nxext/nuxt](https://github.com/nxext/nx-extensions/tree/main/packages/nuxt) is a Nx plugin to bring [Nuxt3](https://nuxt.com/) to [Nx](https://nx.dev/). | ||
|
||
## Adding the Nuxt plugin | ||
|
||
Adding the Nuxt plugin to a workspace can be done with the following: | ||
|
||
```bash | ||
#yarn | ||
yarn add -D @nxext/nuxt | ||
``` | ||
|
||
```bash | ||
#npm | ||
npm install -D @nxext/nuxt | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,7 @@ | ||
# Introduction to Nxext Sveltekit | ||
|
||
::: warning | ||
This plugin is in alpha state. It is not feature complete yet and not ready for production. | ||
::: | ||
|
||
[@nxext/sveltekit](https://github.com/nxext/nx-extensions/tree/main/packages/sveltekit) is a nx plugin to bring [Sveltekit](https://kit.svelte.dev) to [Nx](https://nx.dev/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -53,14 +53,16 @@ | |
"packageManager": "[email protected]", | ||
"dependencies": {}, | ||
"devDependencies": { | ||
"@nuxt/kit": "^3.6.5", | ||
"@nx/angular": "16.7.1", | ||
"@nx/cypress": "16.7.1", | ||
"@nx/playwright": "16.7.1", | ||
"@nx/devkit": "16.7.1", | ||
"@nx/eslint-plugin": "16.7.1", | ||
"@nx/jest": "16.7.1", | ||
"@nx/js": "16.7.1", | ||
"@nx/linter": "16.7.1", | ||
"@nx/node": "16.7.1", | ||
"@nx/playwright": "16.7.1", | ||
"@nx/plugin": "16.7.1", | ||
"@nx/react": "16.7.1", | ||
"@nx/storybook": "16.7.1", | ||
|
@@ -100,10 +102,12 @@ | |
"is-ci": "^3.0.1", | ||
"jest": "29.4.3", | ||
"jest-environment-jsdom": "29.5.0", | ||
"jest-environment-node": "^29.4.1", | ||
"jsonc-eslint-parser": "^2.3.0", | ||
"jsonc-parser": "^3.2.0", | ||
"kill-port": "^2.0.1", | ||
"lint-staged": "13.2.3", | ||
"nuxt": "^3.6.5", | ||
"nx": "16.7.1", | ||
"nx-cloud": "16.4.0-beta.1", | ||
"prettier": "2.7.1", | ||
|
@@ -119,6 +123,7 @@ | |
"verdaccio": "5.18.0", | ||
"verdaccio-auth-memory": "^10.2.2", | ||
"vite-plugin-solid": "^2.7.0", | ||
"vite-tsconfig-paths": "^4.2.0", | ||
"vitepress": "^1.0.0-rc.4", | ||
"vue-component-meta": "^1.8.8", | ||
"yargs": "^17.7.2", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
{ | ||
"extends": ["../../.eslintrc.json"], | ||
"ignorePatterns": ["!**/*"], | ||
"overrides": [ | ||
{ | ||
"files": ["*.ts", "*.tsx", "*.js", "*.jsx"], | ||
"rules": {} | ||
}, | ||
{ | ||
"files": ["*.ts", "*.tsx"], | ||
"rules": {} | ||
}, | ||
{ | ||
"files": ["*.js", "*.jsx"], | ||
"rules": {} | ||
}, | ||
{ | ||
"files": ["*.json"], | ||
"parser": "jsonc-eslint-parser", | ||
"rules": { | ||
"@nx/dependency-checks": "error" | ||
} | ||
} | ||
] | ||
} |
Oops, something went wrong.