Skip to content

Commit 2dfa735

Browse files
committed
chore: Init the project
0 parents  commit 2dfa735

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+25673
-0
lines changed

.eslintrc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"parser": "@typescript-eslint/parser",
3+
"plugins": ["@typescript-eslint", "jest", "prettier"],
4+
"extends": [
5+
"plugin:@typescript-eslint/recommended",
6+
"plugin:@typescript-eslint/recommended-requiring-type-checking",
7+
"prettier",
8+
"prettier/@typescript-eslint"
9+
],
10+
"parserOptions": {
11+
"project": "./tsconfig.json"
12+
},
13+
"rules": {
14+
"prettier/prettier": "error",
15+
"@typescript-eslint/explicit-function-return-type": "off",
16+
"@typescript-eslint/no-explicit-any": "off",
17+
"@typescript-eslint/unbound-method": "off"
18+
}
19+
}

.gitignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
node_modules
2+
coverage
3+
.nyc_output
4+
.DS_Store
5+
*.log
6+
.vscode
7+
.idea
8+
dist
9+
compiled
10+
.awcache
11+
.rpt2_cache
12+
docs

.storybook/addons.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
import '@storybook/addon-viewport/register';
2+
import '@storybook/addon-notes/register-panel';

.storybook/config.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
import { configure } from '@storybook/vue'
2+
import { loadStories } from './configureStorybook'
3+
import Vue from 'vue'
4+
import VueCompositionApi from '@vue/composition-api'
5+
6+
Vue.use(VueCompositionApi)
7+
8+
configure(loadStories, module)

.storybook/configureStorybook.js

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
import { addParameters } from '@storybook/vue'
2+
import { create } from '@storybook/theming'
3+
import pkg from '../package.json'
4+
// Global styling and icons
5+
import './styles.css'
6+
import 'bulma/css/bulma.css'
7+
import '@fortawesome/fontawesome-free/css/all.css'
8+
9+
const basicTheme = create({
10+
base: 'light',
11+
brandTitle: 'Vue use kit',
12+
brandUrl: pkg.repository.url,
13+
brandImage: null
14+
})
15+
16+
addParameters({
17+
options: {
18+
showPanel: true,
19+
panelPosition: 'right',
20+
theme: basicTheme
21+
}
22+
})
23+
24+
export function loadStories() {
25+
const req = require.context('../src', true, /\.story\.ts$/)
26+
req.keys().forEach(mod => req(mod))
27+
}

.storybook/styles.css

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.sb-show-main {
2+
padding: 30px;
3+
}

.storybook/webpack.config.js

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
module.exports = ({ config }) => {
2+
// Enable typescript support
3+
config.module.rules.push({
4+
test: /\.tsx?$/,
5+
use: [
6+
{
7+
loader: require.resolve('babel-loader'),
8+
options: {
9+
compact: true
10+
}
11+
},
12+
{
13+
loader: require.resolve('ts-loader'),
14+
options: {
15+
appendTsSuffixTo: [/\.vue$/]
16+
}
17+
}
18+
]
19+
})
20+
21+
config.node = {
22+
__dirname: true
23+
}
24+
25+
config.resolve.extensions.push('.ts', '.tsx')
26+
return config
27+
}

.travis.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
language: node_js
2+
cache:
3+
directories:
4+
- ~/.npm
5+
notifications:
6+
email: false
7+
node_js:
8+
- '10'
9+
script:
10+
- npm run test:prod && npm run build
11+
after_success:
12+
- if [ "$TRAVIS_BRANCH" = "master" -a "$TRAVIS_PULL_REQUEST" = "false" ]; then npm run travis-deploy-once "npm run deploy-docs"; fi
13+
- if [ "$TRAVIS_BRANCH" = "master" -a "$TRAVIS_PULL_REQUEST" = "false" ]; then npm run travis-deploy-once "npm run semantic-release"; fi
14+
branches:
15+
except:
16+
- /^v\d+\.\d+\.\d+$/

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
We're really glad you're reading this, because we need volunteer developers to help this project come to fruition. 👏
2+
3+
## Instructions
4+
5+
These steps will guide you through contributing to this project:
6+
7+
- Fork the repo
8+
- Clone it and install dependencies
9+
10+
git clone https://github.com/YOUR-USERNAME/typescript-library-starter
11+
npm install
12+
13+
Keep in mind that after running `npm install` the git repo is reset. So a good way to cope with this is to have a copy of the folder to push the changes, and the other to try them.
14+
15+
Make and commit your changes. Make sure the commands npm run build and npm run test:prod are working.
16+
17+
Finally send a [GitHub Pull Request](https://github.com/alexjoverm/typescript-library-starter/compare?expand=1) with a clear list of what you've done (read more [about pull requests](https://help.github.com/articles/about-pull-requests/)). Make sure all of your commits are atomic (one feature per commit).

LICENSE

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright 2017 Salvatore Tedde <[email protected]>
2+
3+
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:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
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.

0 commit comments

Comments
 (0)