Skip to content

Commit

Permalink
Add configuration for vue-styleguidist
Browse files Browse the repository at this point in the history
  • Loading branch information
OrcaXS committed Apr 1, 2018
1 parent d49197f commit 818892b
Show file tree
Hide file tree
Showing 3 changed files with 93 additions and 2 deletions.
14 changes: 14 additions & 0 deletions .babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
// This .babelrc is currently only used by vue-styleguidist
{
"presets": [
[
"env",
{
"targets": {
"browsers": ["> 1%", "last 2 versions", "not ie <= 11"]
},
}
],
["vue-app"]
],
}
18 changes: 16 additions & 2 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ module.exports = {
],
// required to lint *.vue files
plugins: [
// 'html'
'jsdoc',
],
// check if imports actually resolve
settings: {
Expand Down Expand Up @@ -50,6 +50,20 @@ module.exports = {
// allow optionalDependencies
'import/no-extraneous-dependencies': 'off',
// allow debugger during development
'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0
'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,

// jsdoc
'jsdoc/check-param-names': 1,
'jsdoc/check-tag-names': 1,
'jsdoc/check-types': 1,
'jsdoc/newline-after-description': 1,
'jsdoc/require-description-complete-sentence': 1,
'jsdoc/require-hyphen-before-param-description': 1,
'jsdoc/require-param': 1,
'jsdoc/require-param-description': 1,
'jsdoc/require-param-name': 1,
'jsdoc/require-param-type': 1,
'jsdoc/require-returns-description': 1,
'jsdoc/require-returns-type': 1,
}
}
63 changes: 63 additions & 0 deletions styleguide.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
const resolve = require('path').resolve; // eslint-disable-line
const rules = require('vue-webpack-loaders');

module.exports = {
// components() {
// return ['components#<{(||)}>#*.vue', 'pages#<{(||)}>#*.vue'];
// },
sections: [
{
name: 'Components',
sections: [
{
name: 'Common',
components: 'components/Common/*.vue',
description: 'Common Components.',
},
{
name: 'Loop',
components: 'components/Loop/*.vue',
description: 'Components for Loop Page.'
},
{
name: 'Navbar',
components: 'components/Navbar/*.vue',
description: 'Navbar Components.',
},
{
name: 'Series',
components: 'components/Series/*.vue',
description: 'Components for Series/Episodes Page.',
},
{
name: 'Loading',
components: 'components/Loading.vue',
description: 'Nuxt Loading Progress Bar.',
},
],
},
{
name: 'Pages',
components: 'pages/**/*.vue',
},
],
// components: '@(components|pages)#<{(||)}>#*.vue',
webpackConfig: {
resolve: {
modules: [resolve(__dirname, 'lib'), 'node_modules'],
extensions: ['.js', '.vue'],
alias: {
'~': __dirname,
'@': __dirname,
// your aliases go here.
},
},

module: {
rules,
},
},
showUsage: true,
vuex: 'store/index.js',

};

0 comments on commit 818892b

Please sign in to comment.