Nuxt 3 "v3" branch

.editorconfig

@@ -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

.eslintignore

@@ -0,0 +1,2 @@
+dist
+node_modules

.eslintrc

@@ -0,0 +1,10 @@
+{
+  "extends": [
+    "@nuxtjs/eslint-config-typescript"
+  ],
+  "rules": {
+    "@typescript-eslint/no-unused-vars": [
+      "off"
+    ]
+  }
+}

.gitignore

@@ -1,4 +1,51 @@
-.nuxt/
-coverage/
-node_modules/
-dist/
+# Dependencies
+node_modules
+
+# Logs
+*.log*
+
+# Temp directories
+.temp
+.tmp
+.cache
+
+# Yarn
+**/.yarn/cache
+**/.yarn/*state*
+
+# Generated dirs
+dist
+
+# Nuxt
+.nuxt
+.output
+.vercel_build_output
+.build-*
+.env
+.netlify
+
+# Env
+.env
+
+# Testing
+reports
+coverage
+*.lcov
+.nyc_output
+
+# VSCode
+.vscode
+
+# Intellij idea
+*.iml
+.idea
+
+# OSX
+.DS_Store
+.AppleDouble
+.LSOverride
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk

README.md

@@ -1,141 +1,24 @@
-# @nuxtjs/dayjs
+# @nathanchase/nuxt-dayjs-module
 
-[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
-[![donate: Patreon](https://img.shields.io/badge/donate-patreon-orange.svg?style=flat-square)](https://www.patreon.com/potato4d)
-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](https://opensource.org/licenses/MIT)
-[![NPM version](https://img.shields.io/npm/v/@nuxtjs/dayjs.svg?style=flat-square)](https://npmjs.com/package/@nuxtjs/dayjs)
-[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors)
-[![NPM downloads](https://img.shields.io/npm/dm/@nuxtjs/dayjs.svg?style=flat)](https://npmjs.com/package/@nuxtjs/dayjs)
-[![codecov](https://codecov.io/gh/nuxt-community/dayjs-module/branch/master/graph/badge.svg)](https://codecov.io/gh/nuxt-community/dayjs-module)
-
-> The best way for use Day.js easily in your Nuxt.js project.
-
-<a href="https://patreon.com/potato4d">
-  <img src="https://c5.patreon.com/external/logo/[email protected]" height="50">
-</a>
-
-## Installation
-
-```bash
-$ yarn add @nuxtjs/dayjs # or npm install
-```
-
-## Usage
-
-### 1. Register dayjs module to your Nuxt Application
+This is a Nuxt 3 compatible module built with the official Nuxt 3 [module-builder](https://github.com/nuxt/module-builder) for [dayjs](https://github.com/iamkun/dayjs/). This is meant as a Nuxt 3 version of [dayjs-module](https://github.com/nuxt-community/dayjs-module) to satisfy [Nuxt 3 support](https://github.com/nuxt-community/dayjs-module/issues/376).
 
+Add plugins via configuration in nuxt.config like so:
 ```js
-export default {
-  // ...
-  modules: [
-    '@nuxtjs/dayjs'
-  ],
-
-  // Optional
-  dayjs: {
-    locales: ['en', 'ja'],
-    defaultLocale: 'en',
-    defaultTimeZone: 'Asia/Tokyo',
+dayjs: {
     plugins: [
-      'utc', // import 'dayjs/plugin/utc'
-      'timezone' // import 'dayjs/plugin/timezone'
-    ] // Your Day.js plugin
-  }
-  // ...
-}
-```
-
-### 2. Use $dayjs on Context, Vue instance
-
-with Context
-
-```html
-<script>
-export default {
-  asyncData({ $dayjs }) {
-    return {
-      now: $dayjs().format('YYYY/MM/DD')
-    }
-  }
-}
-</script>
-```
-
-with Vue instance
-
-```html
-<script>
-export default {
-  data() {
-    return {
-      latestClicked: null
-    }
-  },
-  methods: {
-    handleClickButton() {
-      this.latestClicked = this.$dayjs().format('YYYY/MM/DD')
-    }
-  }
-}
-</script>
-```
-
-### For Typescript users
-
-Add the types to your `"types"` array in `tsconfig.json` after the `@nuxt/types` entry.
-
-For dayjs plugins, add their relative types like `dayjs/plugin/_pluginName_`.
-
-#### tsconfig.json
-
-```json
-{
-  "compilerOptions": {
-    "types": [
-      "@nuxt/types",
-      "@nuxtjs/dayjs",
-      "dayjs/plugin/relativeTime",
+      'duration',
+      'relativeTime',
+      'advancedFormat',
+      'weekday'
     ]
-  }
 }
 ```
 
-## Development
-
-```bash
-$ git clone https://github.com/nuxt-community/dayjs-module.git
-$ cd @nuxtjs/dayjs
-$ yarn
-```
+See [/playground/app.vue](https://github.com/nathanchase/dayjs/blob/master/playground/app.vue) for working examples.
 
-## License
+On npm: [https://www.npmjs.com/package/@nathanchase/nuxt-dayjs-module](https://www.npmjs.com/package/@nathanchase/nuxt-dayjs-module)
 
-MIT @potato4d
-
-## Note
-
-This project generated by [create-nuxt-module](https://github.com/potato4d/create-nuxt-module)
-
-## Contributors
-
-Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
-
-<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
-<table>
-  <tr>
-    <td align="center"><a href="https://potato4d.me"><img src="https://github.com/potato4d.png?s=100" width="100px;" alt=""/><br /><sub><b>Takuma HANATANI(@potato4d)</b></sub></a><br /><a href="https://github.com/nuxt-community/dayjs-module/commits?author=potato4d" title="Code">💻</a> <a href="https://github.com/nuxt-community/dayjs-module/issues?q=author%3Apotato4d" title="Bug reports">🐛</a> <a href="https://github.com/nuxt-community/dayjs-module/commits?author=potato4d" title="Documentation">📖</a> <a href="#example-potato4d" title="Examples">💡</a> <a href="#question-potato4d" title="Answering Questions">💬</a> <a href="https://github.com/nuxt-community/dayjs-module/pulls?q=is%3Apr+reviewed-by%3Apotato4d" title="Reviewed Pull Requests">👀</a></td>
-    <td align="center"><a href="https://github.com/bvelastegui"><img src="https://avatars2.githubusercontent.com/u/16880910?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Bryan Daniel Velastegui Lucero</b></sub></a><br /><a href="https://github.com/nuxt-community/dayjs-module/commits?author=bvelastegui" title="Code">💻</a></td>
-    <td align="center"><a href="http://resume.a-wei.tw"><img src="https://avatars0.githubusercontent.com/u/19729705?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Wei</b></sub></a><br /><a href="https://github.com/nuxt-community/dayjs-module/commits?author=a65162" title="Code">💻</a></td>
-    <td align="center"><a href="https://kazuemon.me"><img src="https://avatars1.githubusercontent.com/u/12812934?v=4?s=100" width="100px;" alt=""/><br /><sub><b>かずえもん</b></sub></a><br /><a href="https://github.com/nuxt-community/dayjs-module/commits?author=kazuemon" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://daikiojm.me/"><img src="https://avatars.githubusercontent.com/u/10055293?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Daiki Ojima</b></sub></a><br /><a href="https://github.com/nuxt-community/dayjs-module/commits?author=daikiojm" title="Code">💻</a></td>
-  </tr>
-</table>
-
-<!-- markdownlint-restore -->
-<!-- prettier-ignore-end -->
-
-<!-- ALL-CONTRIBUTORS-LIST:END -->
+## Development
 
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+- Run `npm run dev:prepare` to generate type stubs.
+- Use `npm run dev` to start [playground](./playground) in development mode.