@nuxt/ui 2.18.4 → 3.0.0-alpha.1

package/README.md

@@ -27,7 +27,24 @@ Read more on [ui.nuxt.com](https://ui.nuxt.com)
 ## Installation
 
 ```bash
-npx nuxi@latest module add ui
+# npm
+npm install @nuxt/ui
+# yarn
+yarn add @nuxt/ui
+# pnpm
+pnpm add @nuxt/ui
+# bun
+bun add @nuxt/ui
+```
+
+Then, register the module in your `nuxt.config.ts`:
+
+```js
+export default defineNuxtConfig({
+  modules: [
+    '@nuxt/ui'
+  ]
+})
 ```
 
 If you want latest updates, please use `@nuxt/ui-edge` in your `package.json`:
@@ -77,7 +94,7 @@ Licensed under the [MIT license](https://github.com/nuxt/ui/blob/dev/LICENSE.md)
 [npm-downloads-href]: https://npmjs.com/package/@nuxt/ui
 
 [license-src]: https://img.shields.io/github/license/nuxt/ui.svg?style=flat&colorA=18181B&colorB=28CF8D
-[license-href]: https://github.com/nuxt/ui/blob/main/LICENSE
+[license-href]: https://github.com/nuxt/ui/blob/main/LICENSE.md
 
 [nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
 [nuxt-href]: https://nuxt.com

package/cli/commands/init.mjs

@@ -0,0 +1,83 @@
+import { existsSync, promises as fsp } from 'node:fs'
+import { resolve } from 'pathe'
+import { defineCommand } from 'citty'
+import { consola } from 'consola'
+import { splitByCase, upperFirst, camelCase, kebabCase } from 'scule'
+import { appendFile, sortFile } from '../utils.mjs'
+import templates from '../templates.mjs'
+
+export default defineCommand({
+  meta: {
+    name: 'init',
+    description: 'Init a new component.'
+  },
+  args: {
+    name: {
+      type: 'positional',
+      required: true,
+      description: 'Name of the component.'
+    },
+    primitive: {
+      type: 'boolean',
+      description: 'Create a primitive component.'
+    },
+    pro: {
+      type: 'boolean',
+      description: 'Create a pro component.'
+    },
+    prose: {
+      type: 'boolean',
+      description: 'Create a prose component (with --pro).'
+    },
+    content: {
+      type: 'boolean',
+      description: 'Create a content component (with --pro).'
+    }
+  },
+  async setup({ args }) {
+    const name = args.name
+    if (!name) {
+      consola.error('`name` argument is missing!')
+      process.exit(1)
+    }
+
+    if (args.prose && !args.pro) {
+      consola.error('`--prose` flag can only be used with `--pro` flag!')
+      process.exit(1)
+    }
+    if (args.content && !args.pro) {
+      consola.error('`--content` flag can only be used with `--pro` flag!')
+      process.exit(1)
+    }
+
+    const path = resolve('.')
+
+    for (const template of Object.keys(templates)) {
+      const { filename, contents } = templates[template](args)
+      if (!contents) {
+        continue
+      }
+
+      const filePath = resolve(path, filename)
+
+      if (existsSync(filePath)) {
+        consola.error(`🚨 ${filePath} already exists!`)
+        continue
+      }
+
+      await fsp.writeFile(filePath, contents.trim() + '\n')
+
+      consola.success(`🪄 Generated ${filePath}!`)
+    }
+
+    const themePath = resolve(path, `src/theme/${args.prose ? 'prose/' : ''}${args.content ? 'content/' : ''}index.ts`)
+    await appendFile(themePath, `export { default as ${camelCase(name)} } from './${kebabCase(name)}'`)
+    await sortFile(themePath)
+
+    if (!args.prose) {
+      const typesPath = resolve(path, 'src/runtime/types/index.d.ts')
+      await appendFile(typesPath, `export * from '../components/${args.content ? 'content/' : ''}${splitByCase(name).map(p => upperFirst(p)).join('')}.vue'`)
+      await sortFile(typesPath)
+    }
+  }
+})

package/cli/index.mjs

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+import { defineCommand, runMain } from 'citty'
+import init from './commands/init.mjs'
+
+const main = defineCommand({
+  meta: {
+    name: 'nuxt-ui',
+    description: 'Nuxt UI CLI'
+  },
+  subCommands: {
+    init
+  }
+})
+
+runMain(main)

package/cli/node_modules/.ignored/citty/LICENSE

@@ -0,0 +1,36 @@
+MIT License
+
+Copyright (c) Pooya Parsa <pooya@pi0.io>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+Parser is based on https://github.com/lukeed/mri
+
+The MIT License (MIT)
+
+Copyright (c) Luke Edwards luke.edwards05@gmail.com (lukeed.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

package/cli/node_modules/.ignored/citty/README.md

@@ -0,0 +1,134 @@
+# 🌆 citty
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![bundle][bundle-src]][bundle-href]
+[![Codecov][codecov-src]][codecov-href]
+[![License][license-src]][license-href]
+
+> Elegant CLI Builder
+
+- Fast and lightweight argument parser based on [mri](https://github.com/lukeed/mri)
+- Smart value parsing with typecast, boolean shortcuts and unknown flag handling
+- Nested sub-commands
+- Lazy and Async commands
+- Plugable and composable API
+- Auto generated usage and help
+
+🚧 This project is under heavy development. More features are coming soon!
+
+## Usage
+
+Install package:
+
+```sh
+# npm
+npm install citty
+
+# yarn
+yarn add citty
+
+# pnpm
+pnpm install citty
+```
+
+Import:
+
+```js
+// ESM
+import { defineCommand, runMain } from "citty";
+
+// CommonJS
+const { defineCommand, runMain } = require("citty");
+```
+
+Define main command to run:
+
+```ts
+import { defineCommand, runMain } from "citty";
+
+const main = defineCommand({
+  meta: {
+    name: "hello",
+    version: "1.0.0",
+    description: "My Awesome CLI App",
+  },
+  args: {
+    name: {
+      type: "positional",
+      description: "Your name",
+      required: true,
+    },
+    friendly: {
+      type: "boolean",
+      description: "Use friendly greeting",
+    },
+  },
+  run({ args }) {
+    console.log(`${args.friendly ? "Hi" : "Greetings"} ${args.name}!`);
+  },
+});
+
+runMain(main);
+```
+
+## Utils
+
+### `defineCommand`
+
+`defineCommand` is a type helper for defining commands.
+
+### `runMain`
+
+Runs a command with usage support and graceful error handling.
+
+### `createMain`
+
+Create a wrapper around command that calls `runMain` when called.
+
+### `runCommand`
+
+Parses input args and runs command and sub-commands (unsupervised). You can access `result` key from returnd/awaited value to access command's result.
+
+### `parseArgs`
+
+Parses input arguments and applies defaults.
+
+### `renderUsage`
+
+Renders command usage to a string value.
+
+### `showUsage`
+
+Renders usage and prints to the console
+
+## Development
+
+- Clone this repository
+- Install latest LTS version of [Node.js](https://nodejs.org/en/)
+- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
+- Install dependencies using `pnpm install`
+- Run interactive tests using `pnpm dev`
+
+## License
+
+Made with 💛 Published under [MIT License](./LICENSE).
+
+Argument parser is based on [lukeed/mri](https://github.com/lukeed/mri) by Luke Edwards ([@lukeed](https://github.com/lukeed)).
+
+<!-- Badges -->
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/citty?style=flat&colorA=18181B&colorB=F0DB4F
+[npm-version-href]: https://npmjs.com/package/citty
+[npm-downloads-src]: https://img.shields.io/npm/dm/citty?style=flat&colorA=18181B&colorB=F0DB4F
+[npm-downloads-href]: https://npmjs.com/package/citty
+[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/citty/main?style=flat&colorA=18181B&colorB=F0DB4F
+[codecov-href]: https://codecov.io/gh/unjs/citty
+[bundle-src]: https://img.shields.io/bundlephobia/minzip/citty?style=flat&colorA=18181B&colorB=F0DB4F
+[bundle-href]: https://bundlephobia.com/result?p=citty
+[license-src]: https://img.shields.io/github/license/unjs/citty.svg?style=flat&colorA=18181B&colorB=F0DB4F
+[license-href]: https://github.com/unjs/citty/blob/main/LICENSE
+[jsdocs-src]: https://img.shields.io/badge/jsDocs.io-reference-18181B?style=flat&colorA=18181B&colorB=F0DB4F
+[jsdocs-href]: https://www.jsdocs.io/package/citty