@nuxt/modules 0.5.0-bb827e → 0.5.0-bbfca2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/{dist/modules.json → modules.json} +1145 -950
- package/package.json +2 -26
- package/LICENSE +0 -21
- package/README.md +0 -129
package/package.json
CHANGED
|
@@ -1,30 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nuxt/modules",
|
|
3
|
-
"version": "0.5.0-
|
|
3
|
+
"version": "0.5.0-bbfca2",
|
|
4
4
|
"license": "MIT",
|
|
5
|
-
"main": "
|
|
6
|
-
"files": [
|
|
7
|
-
"dist"
|
|
8
|
-
],
|
|
9
|
-
"scripts": {
|
|
10
|
-
"build": "yarn sync && yarn cli build",
|
|
11
|
-
"cli": "jiti ./scripts/cli",
|
|
12
|
-
"lint": "eslint --ext .vue,.ts .",
|
|
13
|
-
"release": "yarn cli version && npm publish",
|
|
14
|
-
"sync": "yarn cli sync",
|
|
15
|
-
"test": "yarn lint && yarn sync"
|
|
16
|
-
},
|
|
17
|
-
"devDependencies": {
|
|
18
|
-
"@nuxtjs/eslint-config-typescript": "^7.0.2",
|
|
19
|
-
"@types/js-yaml": "^4.0.4",
|
|
20
|
-
"@types/node": "^16.11.7",
|
|
21
|
-
"defu": "^5.0.0",
|
|
22
|
-
"eslint": "^8.2.0",
|
|
23
|
-
"globby": "^12.0.2",
|
|
24
|
-
"hasha": "^5.2.2",
|
|
25
|
-
"jiti": "^1.12.9",
|
|
26
|
-
"js-yaml": "^4.1.0",
|
|
27
|
-
"ohmyfetch": "^0.4.2",
|
|
28
|
-
"typescript": "^4.4.4"
|
|
29
|
-
}
|
|
5
|
+
"main": "./modules.json"
|
|
30
6
|
}
|
package/LICENSE
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2020 Nuxt Team
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
package/README.md
DELETED
|
@@ -1,129 +0,0 @@
|
|
|
1
|
-
# Nuxt Modules
|
|
2
|
-
|
|
3
|
-
[](#)
|
|
4
|
-
[](https://www.npmjs.com/package/@nuxt/modules)
|
|
5
|
-
|
|
6
|
-
> Discover Nuxt modules to supercharge your project! Created by the Nuxt team and community.
|
|
7
|
-
|
|
8
|
-
👉 https://modules.nuxtjs.org
|
|
9
|
-
|
|
10
|
-
## Modules Database
|
|
11
|
-
|
|
12
|
-
Metadata of nuxt modules are maintained in [yml](https://en.wikipedia.org/wiki/YAML) files inside [./modules](./modules) directory and automatically synced from upstream to fetch latest information.
|
|
13
|
-
|
|
14
|
-
### Contribution
|
|
15
|
-
|
|
16
|
-
- If you feel a module is missing, please create a new [issue](https://github.com/nuxt/modules/issues/new)
|
|
17
|
-
- If some data is outdated please directly openin a pull request
|
|
18
|
-
|
|
19
|
-
### Using CDN
|
|
20
|
-
|
|
21
|
-
Compiled JSON data is available from following CDNs:
|
|
22
|
-
|
|
23
|
-
- **jsdelivr:**: https://cdn.jsdelivr.net/npm/@nuxt/modules@latest/dist/modules.json
|
|
24
|
-
- **unpkg:** https://unpkg.com/@nuxt/modules@latest/dist/modules.json
|
|
25
|
-
|
|
26
|
-
### Using npm package
|
|
27
|
-
|
|
28
|
-
You can use the `@nuxt/modules` package by installing it in your project:
|
|
29
|
-
|
|
30
|
-
```bash
|
|
31
|
-
# npm
|
|
32
|
-
npm install @nuxt/modules
|
|
33
|
-
|
|
34
|
-
# yarn
|
|
35
|
-
yarn add @nuxt/modules
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
Then you can directly import the list of modules:
|
|
39
|
-
|
|
40
|
-
```js
|
|
41
|
-
// ESM
|
|
42
|
-
import modules from '@nuxt/modules'
|
|
43
|
-
|
|
44
|
-
// CommonJS
|
|
45
|
-
const modules = require('@nuxt/modules')
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
### Schema
|
|
49
|
-
|
|
50
|
-
Field Name | Auto sync | Description
|
|
51
|
-
----------------|-----------|--------------
|
|
52
|
-
`name` | No | Canonical name or integration name
|
|
53
|
-
`description` | Yes | Short description
|
|
54
|
-
`repo` | No | Github repository. Format is `org/name` or `org/name#main/path`
|
|
55
|
-
`npm` | Yes | NPM package name
|
|
56
|
-
`icon` | No | Icon of module from [./website/static/icons](./website/static/icons) directory
|
|
57
|
-
`github` | No | Github URL
|
|
58
|
-
`website` | No | Website URL
|
|
59
|
-
`learn_more` | No | Link to learn more (website or relevant integration website)
|
|
60
|
-
`category` | No | Module category from [./lib/categories.json](./lib/categories.json)
|
|
61
|
-
`type` | No | `community` (for [nuxt-community](https://github.com/nuxt-community/)), `official` (for https://github.com/) or `3rd-party`
|
|
62
|
-
`maintainers` | Yes | List of maintainers each item has `name`, `github` and `avatar`
|
|
63
|
-
`compatibility` | No | Module compatibility status. Valid keys are `2.x`, `2.x-bridge` and `3.x` and valid values are `working`, `wip`, `unknown`, `broken` and `rip`. Please see [this discussion](https://github.com/nuxt/framework/discussions/751) for more information.
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
## Maintenance
|
|
67
|
-
|
|
68
|
-
### Add or update repository
|
|
69
|
-
|
|
70
|
-
```bash
|
|
71
|
-
yarn sync <name> <repo>
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
Example: `yarn sync tailwindcss nuxt-community/tailwindcss-module`
|
|
75
|
-
|
|
76
|
-
To sync with a branch different than `master`, suffix the repo with `#repo-branch`, example: `yarn sync tailwindcss nuxt-community/tailwindcss-module#dev`
|
|
77
|
-
|
|
78
|
-
### Auto update all current modules
|
|
79
|
-
|
|
80
|
-
```bash
|
|
81
|
-
yarn sync
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
### Generate `dist/module.json`
|
|
85
|
-
|
|
86
|
-
```sh
|
|
87
|
-
yarn build
|
|
88
|
-
```
|
|
89
|
-
|
|
90
|
-
## Website development
|
|
91
|
-
|
|
92
|
-
- Clone repository
|
|
93
|
-
- Change working directory to website using `cd website`
|
|
94
|
-
- Install website depenedencies using `npx yarn install`
|
|
95
|
-
|
|
96
|
-
Start development:
|
|
97
|
-
|
|
98
|
-
```bash
|
|
99
|
-
npx yarn dev
|
|
100
|
-
```
|
|
101
|
-
|
|
102
|
-
Then visit http://localhost:3000
|
|
103
|
-
|
|
104
|
-
In the development, the npm downloads and GitHub stars will be mocked unless setting `GITHUB_TOKEN` variable.
|
|
105
|
-
|
|
106
|
-
### Production build
|
|
107
|
-
|
|
108
|
-
Create a [personnal GitHub token](https://github.com/settings/tokens) (no scope selected) and add it to `.env`:
|
|
109
|
-
|
|
110
|
-
```sh
|
|
111
|
-
# .env
|
|
112
|
-
GITHUB_TOKEN=<my-generated-github-token>
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
Generate the website:
|
|
116
|
-
|
|
117
|
-
```sh
|
|
118
|
-
yarn generate
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
Start the production website:
|
|
122
|
-
|
|
123
|
-
```sh
|
|
124
|
-
yarn start
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
## License
|
|
128
|
-
|
|
129
|
-
[MIT](./LICENSE) - Made by Nuxt Team
|