Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
woolimi committed Nov 28, 2023
0 parents commit 89b21ac
Show file tree
Hide file tree
Showing 130 changed files with 11,074 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
!.eslintrc.cjs
drafts
scripts
51 changes: 51 additions & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
module.exports = {
root: true,
env: {
node: true,
browser: true,
'vue/setup-compiler-macros': true,
},
extends: ['plugin:vue/vue3-recommended', 'eslint:recommended', '@vue/typescript/recommended'],
plugins: ['vue', 'simple-import-sort', 'unused-imports'],
rules: {
'no-console': 'warn',
'no-alert': 'error',
'simple-import-sort/imports': 'error',
'simple-import-sort/exports': 'error',
'unused-imports/no-unused-imports': 'error',
'@typescript-eslint/no-unused-vars': [
'warn',
{
argsIgnorePattern: '^_',
varsIgnorePattern: '^_',
caughtErrorsIgnorePattern: '^_',
},
],
'@typescript-eslint/no-explicit-any': 'off',
'vue/max-attributes-per-line': 'off',
'vue/no-v-html': 'off',
'vue/singleline-html-element-content-newline': 'off',
'vue/html-self-closing': 'off',
'vue/attributes-order': [
'error',
{
order: [
'LIST_RENDERING',
'CONDITIONALS',
'SLOT',
'RENDER_MODIFIERS',
'TWO_WAY_BINDING',
'DEFINITION',
'GLOBAL',
'UNIQUE',
'ATTR_DYNAMIC',
'ATTR_SHORTHAND_BOOL',
'ATTR_STATIC',
'CONTENT',
'OTHER_DIRECTIVES',
'EVENTS',
],
},
],
},
};
49 changes: 49 additions & 0 deletions .github/workflows/gh-page-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["master"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Install bundles
run: yarn install
- name: Build
run: yarn story:build
- name: Gzip
run: bash ./scripts/gh-pages-gzip.sh
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
# Upload entire repository
path: "./github-pages"
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
26 changes: 26 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

node_modules
dist
dist-ssr
*.local
github-pages
drafts

# Editor directories and files
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
.npmrc
4 changes: 4 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npm run pre-commit
9 changes: 9 additions & 0 deletions .lintstagedrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"*.{scss,css,vue}": [
"stylelint --fix --max-warnings 0 --custom-syntax postcss-html"
],
"*.{js,ts,vue}": [
"eslint --fix",
"prettier --write"
]
}
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v18.17.0
6 changes: 6 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
node_modules/**
assets/**
drafts/**
dist/**
scripts/**
public/**
11 changes: 11 additions & 0 deletions .prettierrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
module.exports = {
trailingComma: 'all',
tabWidth: 2,
semi: true,
singleQuote: true,
endOfLine: 'auto',
arrowParens: 'always',
printWidth: 100,
plugins: ['prettier-plugin-tailwindcss'],
tailwindConfig: './tailwind.config.js',
};
7 changes: 7 additions & 0 deletions .stylelintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"extends": ["stylelint-config-recommended-vue/scss", "stylelint-config-clean-order"],
"ignoreFiles": "styles/responsive.scss",
"rules": {
"no-descending-specificity": null
}
}
3 changes: 3 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"recommendations": ["Vue.volar", "Vue.vscode-typescript-vue-plugin"]
}
23 changes: 23 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
// EDITOR
"editor.formatOnSave": true,
"editor.tabSize": 2,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true,
"source.fixAll.stylelint": true
},
"stylelint.validate": ["css", "scss", "sass", "vue"],
"editor.defaultFormatter": "esbenp.prettier-vscode",
"[vue]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[html]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[typescript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
}
40 changes: 40 additions & 0 deletions Introduction.story.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
group: 'top'
icon: 'carbon:bookmark'
---

<img src="https://raw.githubusercontent.com/woolimi/wool-components/master/assets/sheep.svg" alt="Wool Components" class="mx-auto w-[300px] h-[300px]" />

<h1 class="text-center text-5xl">Wool Components</h1>
<p class="text-2xl text-center">
<span class="font-extrabold">FUCKING NOISY BUT CUTE<span><br/> Vue UI components library
</p>

<br/>
<br/>

<h2 class="text-4xl">🐑 Getting Started</h2>

## 1. Download

```bash
yarn add wool-components@latest
```

## 2. Import `index.css` file in `main.ts`

```js
import { createApp } from 'vue';
import App from './App.vue';
import 'wool-components/dist/index.css';

createApp(App).mount('#app');
```

## 3. Import component

```vue
<script setup>
import { WButton } from 'wool-components';
</script>
```
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<p align="center">
<img src="https://raw.githubusercontent.com/woolimi/wool-components/master/assets/sheep.svg" alt="Wool Components" width="300px" height="300px" />
</p>
<h1 align="center">
:sheep: Wool Components :sheep:
</h1>
<p align="center">
<strong>FUCKING NOISY BUT CUTE</strong>
<p>
<p align="center">
Vue UI components library
</p>

<br/>
<br/>

# :sheep: Demo

[https://woolimi.github.io/wool-components/](https://woolimi.github.io/wool-components/#/)

<br/>
<br/>

# :sheep: Getting Started

## 1. Download

```bash
yarn add wool-components@latest
```

## 2. Import `index.css` file in `main.ts`

```js
import { createApp } from 'vue';
import App from './App.vue';
import 'wool-components/dist/index.css';

createApp(App).mount('#app');
```

## 3. Import component

```vue
<script setup>
import { WButton } from 'wool-components';
</script>
```
Binary file added assets/flags.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 89b21ac

Please sign in to comment.