Skip to content

Commit 993d952

Browse files
committed
chore: 🎉 init nuxt module for vue-dsfr
0 parents  commit 993d952

File tree

20 files changed

+13429
-0
lines changed

20 files changed

+13429
-0
lines changed

.editorconfig

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
root = true
2+
3+
[*]
4+
indent_size = 2
5+
indent_style = space
6+
end_of_line = lf
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
11+
[*.md]
12+
trim_trailing_whitespace = false

.eslintignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
dist
2+
node_modules

.eslintrc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"root": true,
3+
"extends": ["@nuxt/eslint-config"]
4+
}

.gitignore

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Dependencies
2+
node_modules
3+
4+
# Logs
5+
*.log*
6+
7+
# Temp directories
8+
.temp
9+
.tmp
10+
.cache
11+
12+
# Yarn
13+
**/.yarn/cache
14+
**/.yarn/*state*
15+
16+
# Generated dirs
17+
dist
18+
19+
# Nuxt
20+
.nuxt
21+
.output
22+
.data
23+
.vercel_build_output
24+
.build-*
25+
.netlify
26+
27+
# Env
28+
.env
29+
30+
# Testing
31+
reports
32+
coverage
33+
*.lcov
34+
.nyc_output
35+
36+
# VSCode
37+
.vscode/*
38+
!.vscode/settings.json
39+
!.vscode/tasks.json
40+
!.vscode/launch.json
41+
!.vscode/extensions.json
42+
!.vscode/*.code-snippets
43+
44+
# Intellij idea
45+
*.iml
46+
.idea
47+
48+
# OSX
49+
.DS_Store
50+
.AppleDouble
51+
.LSOverride
52+
.AppleDB
53+
.AppleDesktop
54+
Network Trash Folder
55+
Temporary Items
56+
.apdisk

.npmrc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
shamefully-hoist=true
2+
strict-peer-dependencies=false

README.md

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
<!--
2+
Get your module up and running quickly.
3+
4+
Find and replace all on all files (CMD+SHIFT+F):
5+
- Name: My Module
6+
- Package name: my-module
7+
- Description: My new Nuxt module
8+
-->
9+
10+
# My Module
11+
12+
[![npm version][npm-version-src]][npm-version-href]
13+
[![npm downloads][npm-downloads-src]][npm-downloads-href]
14+
[![License][license-src]][license-href]
15+
[![Nuxt][nuxt-src]][nuxt-href]
16+
17+
My new Nuxt module for doing amazing things.
18+
19+
- [&nbsp;Release Notes](/CHANGELOG.md)
20+
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) -->
21+
<!-- - [📖 &nbsp;Documentation](https://example.com) -->
22+
23+
## Features
24+
25+
<!-- Highlight some of the features your module provide here -->
26+
-&nbsp;Foo
27+
- 🚠 &nbsp;Bar
28+
- 🌲 &nbsp;Baz
29+
30+
## Quick Setup
31+
32+
1. Add `my-module` dependency to your project
33+
34+
```bash
35+
# Using pnpm
36+
pnpm add -D my-module
37+
38+
# Using yarn
39+
yarn add --dev my-module
40+
41+
# Using npm
42+
npm install --save-dev my-module
43+
```
44+
45+
2. Add `my-module` to the `modules` section of `nuxt.config.ts`
46+
47+
```js
48+
export default defineNuxtConfig({
49+
modules: [
50+
'my-module'
51+
]
52+
})
53+
```
54+
55+
That's it! You can now use My Module in your Nuxt app ✨
56+
57+
## Development
58+
59+
```bash
60+
# Install dependencies
61+
npm install
62+
63+
# Generate type stubs
64+
npm run dev:prepare
65+
66+
# Develop with the playground
67+
npm run dev
68+
69+
# Build the playground
70+
npm run dev:build
71+
72+
# Run ESLint
73+
npm run lint
74+
75+
# Run Vitest
76+
npm run test
77+
npm run test:watch
78+
79+
# Release new version
80+
npm run release
81+
```
82+
83+
<!-- Badges -->
84+
[npm-version-src]: https://img.shields.io/npm/v/my-module/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
85+
[npm-version-href]: https://npmjs.com/package/my-module
86+
87+
[npm-downloads-src]: https://img.shields.io/npm/dm/my-module.svg?style=flat&colorA=18181B&colorB=28CF8D
88+
[npm-downloads-href]: https://npmjs.com/package/my-module
89+
90+
[license-src]: https://img.shields.io/npm/l/my-module.svg?style=flat&colorA=18181B&colorB=28CF8D
91+
[license-href]: https://npmjs.com/package/my-module
92+
93+
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
94+
[nuxt-href]: https://nuxt.com

0 commit comments

Comments
 (0)