vue3

.eslintrc.yaml

@@ -0,0 +1,33 @@
+extends:
+  - eslint:recommended
+  - plugin:vue/vue3-recommended
+  - plugin:@typescript-eslint/recommended
+  - plugin:@typescript-eslint/recommended-requiring-type-checking
+  - prettier
+
+parserOptions:
+  project: "tsconfig.json"
+
+rules:
+  "func-style":
+    - "error"
+    - "expression"
+  "@typescript-eslint/explicit-module-boundary-types": "warn"
+  "@typescript-eslint/no-unused-vars":
+    - "warn"
+    - varsIgnorePattern: "^_"
+      args: "none"
+      ignoreRestSiblings: true
+  "@typescript-eslint/no-non-null-assertion": "off"
+
+overrides:
+  - files: ["src/**/*.{ts,tsx}"]
+    env:
+      browser: true
+    rules:
+      no-console: "error"
+      no-debugger: "error"
+
+  - files: ["*.{ts,js}"]
+    env:
+      node: true

.github/workflows/lint.yaml

@@ -0,0 +1,26 @@
+name: Lint
+
+on: push
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v2
+        with:
+          node-version-file: .node-version
+          cache: npm
+      - run: npm install
+      - run: npm run lint
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v2
+        with:
+          node-version-file: .node-version
+          cache: npm
+      - run: npm install
+      - run: npm run build:lib

.gitignore

@@ -1,22 +1,3 @@
-.DS_Store
 node_modules
 /dist
-/gh-pages
-
-# local env files
-.env.local
-.env.*.local
-
-# Log files
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Editor directories and files
-.idea
-.vscode
-*.suo
-*.ntvs*
-*.njsproj
-*.sln
-*.sw?
+/site

.node-version

@@ -1 +1 @@
-12.17.0
+16.15.0

LICENSE

@@ -1,24 +1,21 @@
-This is free and unencumbered software released into the public domain.
+MIT License
 
-Anyone is free to copy, modify, publish, use, compile, sell, or
-distribute this software, either in source code form or as a compiled
-binary, for any purpose, commercial or non-commercial, and by any
-means.
+Copyright (c) 2022 Shigeki Suwa
 
-In jurisdictions that recognize copyright laws, the author or authors
-of this software dedicate any and all copyright interest in the
-software to the public domain. We make this dedication for the benefit
-of the public at large and to the detriment of our heirs and
-successors. We intend this dedication to be an overt act of
-relinquishment in perpetuity of all present and future rights to this
-software under copyright law.
+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 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 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.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-For more information, please refer to <https://unlicense.org>
+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.

README.md

@@ -1,62 +1,42 @@
 # @ztrehagem/vue-accordion
 
-## Usage
+![](https://img.shields.io/npm/v/@ztrehagem/vue-accordion/latest)
+![](https://img.shields.io/npm/dependency-version/@ztrehagem/vue-accordion/peer/vue)
+![](https://img.shields.io/npm/types/@ztrehagem/vue-accordion)
+![](https://img.shields.io/github/license/ztrehagem/vue-accordion)
 
-1. Install
+## Installation
 
-    ```
-    npm install @ztrehagem/vue-accordion
-    ```
+```sh
+npm install @ztrehagem/vue-accordion
+```
 
-2. Import default style (optional)
+## Usage
 
-    ```js
-    // for css loaders
-    import '@ztrehagem/vue-accordion/dist/vue-accordion.css'
-    ```
-    or
-    ```scss
-    // for css preprocessors
-    @import '~@ztrehagem/vue-accordion/dist/vue-accordion.css'
-    ```
+1. (Recommended/Optional) Import default style.
 
-3. Use as component
+   This is a minimum style for achieving the behavior of accordion. ([source](./src/lib/style.css))
 
-    ```js
-    import VueAccordion from '@ztrehagem/vue-accordion'
+   ```ts
+   import "@ztrehagem/vue-accordion/style.css";
+   ```
 
-    export default {
-      components: {
-        VueAccordion
-      }
-    }
-    ```
-    ```html
-    <VueAccordion :expanded="isExpanded">
-      <strong>Hello World!</strong>
-    </VueAccordion>
-    ```
+2. Import and use VueAccordion component.
 
+   ```js
+   import { VueAccordion } from "@ztrehagem/vue-accordion";
 
-## Development setup
-```
-npm install
-```
+   export default {
+     components: {
+       VueAccordion,
+     },
+   };
+   ```
 
-### Compiles and hot-reloads for development
-```
-npm run dev
-```
-
-### Compiles and minifies for publish
-```
-npm run build
-```
-
-### Lints and fixes files
-```
-npm run lint
-```
+   ```html
+   <VueAccordion :expanded="isExpanded">
+     <strong>Hello World!</strong>
+   </VueAccordion>
+   ```
 
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
+See [src](./src) for more examples.