Generate ui library
12
packages/ui/.editorconfig
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
root = true
|
||||||
|
|
||||||
|
[*]
|
||||||
|
indent_size = 2
|
||||||
|
indent_style = space
|
||||||
|
end_of_line = lf
|
||||||
|
charset = utf-8
|
||||||
|
trim_trailing_whitespace = true
|
||||||
|
insert_final_newline = true
|
||||||
|
|
||||||
|
[*.md]
|
||||||
|
trim_trailing_whitespace = false
|
||||||
49
packages/ui/.github/workflows/ci.yml
vendored
Normal file
@ -0,0 +1,49 @@
|
|||||||
|
name: ci
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
lint:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: 20
|
||||||
|
|
||||||
|
- run: npm i -g --force corepack@latest && corepack enable
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npx nypm@latest i
|
||||||
|
|
||||||
|
- name: Lint
|
||||||
|
run: npm run lint
|
||||||
|
|
||||||
|
test:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: 20
|
||||||
|
|
||||||
|
- run: npm i -g --force corepack@latest && corepack enable
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npx nypm@latest i
|
||||||
|
|
||||||
|
- name: Playground prepare
|
||||||
|
run: npm run dev:prepare
|
||||||
|
|
||||||
|
- name: Test
|
||||||
|
run: npm run test
|
||||||
56
packages/ui/.gitignore
vendored
Normal file
@ -0,0 +1,56 @@
|
|||||||
|
# Dependencies
|
||||||
|
node_modules
|
||||||
|
|
||||||
|
# Logs
|
||||||
|
*.log*
|
||||||
|
|
||||||
|
# Temp directories
|
||||||
|
.temp
|
||||||
|
.tmp
|
||||||
|
.cache
|
||||||
|
|
||||||
|
# Yarn
|
||||||
|
**/.yarn/cache
|
||||||
|
**/.yarn/*state*
|
||||||
|
|
||||||
|
# Generated dirs
|
||||||
|
dist
|
||||||
|
|
||||||
|
# Nuxt
|
||||||
|
.nuxt
|
||||||
|
.output
|
||||||
|
.data
|
||||||
|
.vercel_build_output
|
||||||
|
.build-*
|
||||||
|
.netlify
|
||||||
|
|
||||||
|
# Env
|
||||||
|
.env
|
||||||
|
|
||||||
|
# Testing
|
||||||
|
reports
|
||||||
|
coverage
|
||||||
|
*.lcov
|
||||||
|
.nyc_output
|
||||||
|
|
||||||
|
# VSCode
|
||||||
|
.vscode/*
|
||||||
|
!.vscode/settings.json
|
||||||
|
!.vscode/tasks.json
|
||||||
|
!.vscode/launch.json
|
||||||
|
!.vscode/extensions.json
|
||||||
|
!.vscode/*.code-snippets
|
||||||
|
|
||||||
|
# Intellij idea
|
||||||
|
*.iml
|
||||||
|
.idea
|
||||||
|
|
||||||
|
# OSX
|
||||||
|
.DS_Store
|
||||||
|
.AppleDouble
|
||||||
|
.LSOverride
|
||||||
|
.AppleDB
|
||||||
|
.AppleDesktop
|
||||||
|
Network Trash Folder
|
||||||
|
Temporary Items
|
||||||
|
.apdisk
|
||||||
2
packages/ui/.npmrc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
shamefully-hoist=true
|
||||||
|
strict-peer-dependencies=false
|
||||||
3
packages/ui/.vscode/settings.json
vendored
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"eslint.experimental.useFlatConfig": true
|
||||||
|
}
|
||||||
84
packages/ui/README.md
Normal file
@ -0,0 +1,84 @@
|
|||||||
|
<!--
|
||||||
|
Get your module up and running quickly.
|
||||||
|
|
||||||
|
Find and replace all on all files (CMD+SHIFT+F):
|
||||||
|
- Name: My Module
|
||||||
|
- Package name: my-module
|
||||||
|
- Description: My new Nuxt module
|
||||||
|
-->
|
||||||
|
|
||||||
|
# My Module
|
||||||
|
|
||||||
|
[![npm version][npm-version-src]][npm-version-href]
|
||||||
|
[![npm downloads][npm-downloads-src]][npm-downloads-href]
|
||||||
|
[![License][license-src]][license-href]
|
||||||
|
[![Nuxt][nuxt-src]][nuxt-href]
|
||||||
|
|
||||||
|
My new Nuxt module for doing amazing things.
|
||||||
|
|
||||||
|
- [✨ Release Notes](/CHANGELOG.md)
|
||||||
|
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) -->
|
||||||
|
<!-- - [📖 Documentation](https://example.com) -->
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
<!-- Highlight some of the features your module provide here -->
|
||||||
|
- ⛰ Foo
|
||||||
|
- 🚠 Bar
|
||||||
|
- 🌲 Baz
|
||||||
|
|
||||||
|
## Quick Setup
|
||||||
|
|
||||||
|
Install the module to your Nuxt application with one command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx nuxi module add my-module
|
||||||
|
```
|
||||||
|
|
||||||
|
That's it! You can now use My Module in your Nuxt app ✨
|
||||||
|
|
||||||
|
|
||||||
|
## Contribution
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Local development</summary>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Install dependencies
|
||||||
|
npm install
|
||||||
|
|
||||||
|
# Generate type stubs
|
||||||
|
npm run dev:prepare
|
||||||
|
|
||||||
|
# Develop with the playground
|
||||||
|
npm run dev
|
||||||
|
|
||||||
|
# Build the playground
|
||||||
|
npm run dev:build
|
||||||
|
|
||||||
|
# Run ESLint
|
||||||
|
npm run lint
|
||||||
|
|
||||||
|
# Run Vitest
|
||||||
|
npm run test
|
||||||
|
npm run test:watch
|
||||||
|
|
||||||
|
# Release new version
|
||||||
|
npm run release
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- Badges -->
|
||||||
|
[npm-version-src]: https://img.shields.io/npm/v/my-module/latest.svg?style=flat&colorA=020420&colorB=00DC82
|
||||||
|
[npm-version-href]: https://npmjs.com/package/my-module
|
||||||
|
|
||||||
|
[npm-downloads-src]: https://img.shields.io/npm/dm/my-module.svg?style=flat&colorA=020420&colorB=00DC82
|
||||||
|
[npm-downloads-href]: https://npm.chart.dev/my-module
|
||||||
|
|
||||||
|
[license-src]: https://img.shields.io/npm/l/my-module.svg?style=flat&colorA=020420&colorB=00DC82
|
||||||
|
[license-href]: https://npmjs.com/package/my-module
|
||||||
|
|
||||||
|
[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
|
||||||
|
[nuxt-href]: https://nuxt.com
|
||||||
20
packages/ui/eslint.config.mjs
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
// @ts-check
|
||||||
|
import { createConfigForNuxt } from '@nuxt/eslint-config/flat'
|
||||||
|
|
||||||
|
// Run `npx @eslint/config-inspector` to inspect the resolved config interactively
|
||||||
|
export default createConfigForNuxt({
|
||||||
|
features: {
|
||||||
|
// Rules for module authors
|
||||||
|
tooling: true,
|
||||||
|
// Rules for formatting
|
||||||
|
stylistic: true,
|
||||||
|
},
|
||||||
|
dirs: {
|
||||||
|
src: [
|
||||||
|
'./playground',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
})
|
||||||
|
.append(
|
||||||
|
// your custom flat config here...
|
||||||
|
)
|
||||||
4
packages/ui/nuxt.config.ts
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
// https://nuxt.com/docs/api/configuration/nuxt-config
|
||||||
|
export default defineNuxtConfig({
|
||||||
|
modules: ["@nuxt/fonts", "@nuxt/icon", "@nuxt/image", "@nuxt/ui"]
|
||||||
|
})
|
||||||
@ -1,15 +1,57 @@
|
|||||||
{
|
{
|
||||||
"name": "ui",
|
"name": "@websites/ui",
|
||||||
"version": "0.0.0",
|
"version": "0.0.0",
|
||||||
"private": true,
|
"description": "My new Nuxt module",
|
||||||
"main": "./index.ts",
|
"repository": "your-org/my-module",
|
||||||
"types": "./index.ts",
|
"license": "MIT",
|
||||||
|
"type": "module",
|
||||||
|
"exports": {
|
||||||
|
".": {
|
||||||
|
"types": "./dist/types.d.mts",
|
||||||
|
"import": "./dist/module.mjs"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"main": "./dist/module.mjs",
|
||||||
|
"typesVersions": {
|
||||||
|
"*": {
|
||||||
|
".": [
|
||||||
|
"./dist/types.d.mts"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"files": [
|
||||||
|
"dist"
|
||||||
|
],
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"lint": "eslint ."
|
"prepack": "nuxt-module-build build",
|
||||||
|
"dev": "npm run dev:prepare && nuxi dev playground",
|
||||||
|
"dev:build": "nuxi build playground",
|
||||||
|
"dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
|
||||||
|
"release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm publish && git push --follow-tags",
|
||||||
|
"lint": "eslint .",
|
||||||
|
"test": "vitest run",
|
||||||
|
"test:watch": "vitest watch",
|
||||||
|
"test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"@nuxt/kit": "^3.17.5"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"eslint-config-custom": "workspace:*",
|
"@nuxt/devtools": "^2.5.0",
|
||||||
"tsconfig": "workspace:*",
|
"@nuxt/eslint-config": "^1.4.1",
|
||||||
"vue": "^3.4.21"
|
"@nuxt/fonts": "0.11.4",
|
||||||
|
"@nuxt/icon": "1.13.0",
|
||||||
|
"@nuxt/image": "1.10.0",
|
||||||
|
"@nuxt/module-builder": "^1.0.1",
|
||||||
|
"@nuxt/schema": "^3.17.5",
|
||||||
|
"@nuxt/test-utils": "^3.19.1",
|
||||||
|
"@nuxt/ui": "3.1.3",
|
||||||
|
"@types/node": "latest",
|
||||||
|
"changelogen": "^0.6.1",
|
||||||
|
"eslint": "^9.28.0",
|
||||||
|
"nuxt": "^3.17.5",
|
||||||
|
"typescript": "~5.8.3",
|
||||||
|
"vitest": "^3.2.3",
|
||||||
|
"vue-tsc": "^2.2.10"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
8
packages/ui/playground/app.vue
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
<template>
|
||||||
|
<div>
|
||||||
|
Nuxt module playground!
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<script setup>
|
||||||
|
</script>
|
||||||
5
packages/ui/playground/nuxt.config.ts
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
export default defineNuxtConfig({
|
||||||
|
modules: ['../src/module'],
|
||||||
|
myModule: {},
|
||||||
|
devtools: { enabled: true },
|
||||||
|
})
|
||||||
13
packages/ui/playground/package.json
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
{
|
||||||
|
"private": true,
|
||||||
|
"name": "my-module-playground",
|
||||||
|
"type": "module",
|
||||||
|
"scripts": {
|
||||||
|
"dev": "nuxi dev",
|
||||||
|
"build": "nuxi build",
|
||||||
|
"generate": "nuxi generate"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"nuxt": "^3.17.5"
|
||||||
|
}
|
||||||
|
}
|
||||||
3
packages/ui/playground/server/tsconfig.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"extends": "../.nuxt/tsconfig.server.json"
|
||||||
|
}
|
||||||
3
packages/ui/playground/tsconfig.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"extends": "./.nuxt/tsconfig.json"
|
||||||
|
}
|
||||||
19
packages/ui/src/module.ts
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
import { defineNuxtModule, addPlugin, createResolver } from '@nuxt/kit'
|
||||||
|
|
||||||
|
// Module options TypeScript interface definition
|
||||||
|
export interface ModuleOptions {}
|
||||||
|
|
||||||
|
export default defineNuxtModule<ModuleOptions>({
|
||||||
|
meta: {
|
||||||
|
name: 'my-module',
|
||||||
|
configKey: 'myModule',
|
||||||
|
},
|
||||||
|
// Default configuration options of the Nuxt module
|
||||||
|
defaults: {},
|
||||||
|
setup(_options, _nuxt) {
|
||||||
|
const resolver = createResolver(import.meta.url)
|
||||||
|
|
||||||
|
// Do not add the extension since the `.ts` will be transpiled to `.mjs` after `npm run prepack`
|
||||||
|
addPlugin(resolver.resolve('./runtime/plugin'))
|
||||||
|
},
|
||||||
|
})
|
||||||
5
packages/ui/src/runtime/plugin.ts
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
import { defineNuxtPlugin } from '#app'
|
||||||
|
|
||||||
|
export default defineNuxtPlugin((_nuxtApp) => {
|
||||||
|
console.log('Plugin injected by my-module!')
|
||||||
|
})
|
||||||
3
packages/ui/src/runtime/server/tsconfig.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"extends": "../../../.nuxt/tsconfig.server.json",
|
||||||
|
}
|
||||||
15
packages/ui/test/basic.test.ts
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
import { fileURLToPath } from 'node:url'
|
||||||
|
import { describe, it, expect } from 'vitest'
|
||||||
|
import { setup, $fetch } from '@nuxt/test-utils/e2e'
|
||||||
|
|
||||||
|
describe('ssr', async () => {
|
||||||
|
await setup({
|
||||||
|
rootDir: fileURLToPath(new URL('./fixtures/basic', import.meta.url)),
|
||||||
|
})
|
||||||
|
|
||||||
|
it('renders the index page', async () => {
|
||||||
|
// Get response to a server-rendered page with `$fetch`.
|
||||||
|
const html = await $fetch('/')
|
||||||
|
expect(html).toContain('<div>basic</div>')
|
||||||
|
})
|
||||||
|
})
|
||||||
6
packages/ui/test/fixtures/basic/app.vue
vendored
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
<template>
|
||||||
|
<div>basic</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<script setup>
|
||||||
|
</script>
|
||||||
7
packages/ui/test/fixtures/basic/nuxt.config.ts
vendored
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
import MyModule from '../../../src/module'
|
||||||
|
|
||||||
|
export default defineNuxtConfig({
|
||||||
|
modules: [
|
||||||
|
MyModule,
|
||||||
|
],
|
||||||
|
})
|
||||||
5
packages/ui/test/fixtures/basic/package.json
vendored
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"private": true,
|
||||||
|
"name": "basic",
|
||||||
|
"type": "module"
|
||||||
|
}
|
||||||
@ -1,5 +1,8 @@
|
|||||||
{
|
{
|
||||||
"extends": "tsconfig/vue.json",
|
"extends": "./.nuxt/tsconfig.json",
|
||||||
"include": ["."],
|
"exclude": [
|
||||||
"exclude": ["dist", "build", "node_modules"]
|
"dist",
|
||||||
|
"node_modules",
|
||||||
|
"playground",
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
15
packages/ui1/package.json
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
{
|
||||||
|
"name": "ui",
|
||||||
|
"version": "0.0.0",
|
||||||
|
"private": true,
|
||||||
|
"main": "./index.ts",
|
||||||
|
"types": "./index.ts",
|
||||||
|
"scripts": {
|
||||||
|
"lint": "eslint ."
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"eslint-config-custom": "workspace:*",
|
||||||
|
"tsconfig": "workspace:*",
|
||||||
|
"vue": "^3.4.21"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
|
Before Width: | Height: | Size: 1.3 KiB After Width: | Height: | Size: 1.3 KiB |
|
Before Width: | Height: | Size: 3.7 KiB After Width: | Height: | Size: 3.7 KiB |
|
Before Width: | Height: | Size: 629 B After Width: | Height: | Size: 629 B |
5
packages/ui1/tsconfig.json
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"extends": "tsconfig/vue.json",
|
||||||
|
"include": ["."],
|
||||||
|
"exclude": ["dist", "build", "node_modules"]
|
||||||
|
}
|
||||||