Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 1 addition & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,3 @@
<!--
Get your module up and running quickly.

Find and replace all on all files (CMD+SHIFT+F):
- Name: Bedtime
- Package name: nuxt-bedtime
- Description: My new Nuxt module
-->

# Bedtime

[![npm version][npm-version-src]][npm-version-href]
Expand All @@ -23,7 +14,6 @@ Check the [playground](https://github.com/timhanlon/bedtime/tree/main/playground

- [✨ &nbsp;Release Notes](/CHANGELOG.md)
- [🏀 Online playground](https://codesandbox.io/p/devbox/github/timhanlon/bedtime/tree/main)
<!-- - [📖 &nbsp;Documentation](https://example.com) -->

## Goals

Expand All @@ -36,11 +26,10 @@ Check the [playground](https://github.com/timhanlon/bedtime/tree/main/playground

## Features

- Compatible with Nuxt 3.15 and Vite 6
- Compatible with Nuxt 3+ and Vite 6+
- Supports Nuxt [layers](https://nuxt.com/docs/getting-started/layers)
- Supports stories co-located with components or in a dedicated stories directory
- Copy Story/Variant templates to clipboard for easy implementation
- The `useStory` composable can be used to build your own [custom story viewer](https://github.com/timhanlon/bedtime/tree/main/playground-custom)

## Usage

Expand Down Expand Up @@ -92,16 +81,6 @@ Note: this does not currently work in the playground, due to `nuxt dev playgroun

Syntax highlighting is provided by [Nuxt Shiki](https://github.com/nuxt-modules/shiki), and can be configured via the `shiki` key in your `nuxt.config.ts`.

<!-- ## Quick Setup

Install the module to your Nuxt application with one command:

```bash
npx nuxi module add bedtime
```

That's it! You can now use Bedtime in your Nuxt app ✨ -->

## Contribution

<details>
Expand Down
8 changes: 6 additions & 2 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// @ts-check
import { createConfigForNuxt } from '@nuxt/eslint-config/flat'
import { createConfigForNuxt } from '@nuxt/eslint-config'

// Run `npx @eslint/config-inspector` to inspect the resolved config interactively
export default createConfigForNuxt({
Expand All @@ -12,7 +12,11 @@ export default createConfigForNuxt({
dirs: {
src: [
'./playground',
'./playground-custom',
],
},
}).append({
files: ['**/pages/**/*.vue'],
rules: {
'vue/multi-word-component-names': 'off',
},
})
39 changes: 20 additions & 19 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
"prepack": "nuxt-module-build build",
"dev": "nuxi dev playground",
"dev:custom": "nuxi dev playground-custom",
"dev:nuxt4": "nuxi dev playground-nuxt4",
"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",
Expand All @@ -30,29 +31,29 @@
"test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit"
},
"dependencies": {
"@nuxt/kit": "^3.15.2",
"@vue/compiler-sfc": "^3.3.0",
"@nuxt/kit": "^4.2.0",
"@vue/compiler-sfc": "^3.5.22",
"change-case": "^5.4.4",
"defu": "^6.1.4",
"nuxt-shiki": "^0.3.0",
"pathe": "^2.0.0",
"tailwind-variants": "^0.3.0"
"nuxt-shiki": "^0.3.1",
"pathe": "^2.0.3",
"tailwind-variants": "^3.1.1"
},
"devDependencies": {
"@nuxt/devtools": "^1.7.0",
"@nuxt/eslint-config": "^0.7.5",
"@nuxt/module-builder": "^0.8.4",
"@nuxt/schema": "^3.15.2",
"@nuxt/test-utils": "^3.15.4",
"@nuxt/ui": "3.0.0-alpha.11",
"@nuxt/devtools": "^2.6.5",
"@nuxt/eslint-config": "^1.9.0",
"@nuxt/module-builder": "^1.0.2",
"@nuxt/schema": "^4.2.0",
"@nuxt/test-utils": "^3.20.1",
"@nuxt/ui": "^4.1.0",
"@types/node": "latest",
"changelogen": "^0.5.7",
"eslint": "^9.17.0",
"nuxt": "^3.15.2",
"playwright": "^1.49.1",
"typescript": "~5.7.2",
"vitest": "^2.1.8",
"vue-tsc": "^2.2.0"
"changelogen": "^0.6.2",
"eslint": "^9.38.0",
"nuxt": "^4.2.0",
"playwright": "^1.56.1",
"typescript": "^5.9.3",
"vitest": "^4.0.3",
"vue-tsc": "3.1.2"
},
"packageManager": "pnpm@9.15.3"
"packageManager": "pnpm@10.19.0"
}
7 changes: 0 additions & 7 deletions playground-custom/app.vue

This file was deleted.

46 changes: 0 additions & 46 deletions playground-custom/components/CustomButton.vue

This file was deleted.

13 changes: 0 additions & 13 deletions playground-custom/components/NuxtBadge.story.vue

This file was deleted.

16 changes: 0 additions & 16 deletions playground-custom/components/NuxtButton.story.vue

This file was deleted.

76 changes: 0 additions & 76 deletions playground-custom/components/ReallyLongStory.story.vue

This file was deleted.

Loading
Loading