@episclera/configkit
v1.5.1
Published
🔧 Shareable configs with good defaults.
Downloads
37
Readme
Usage
Install: npm i -D @episclera/configkit
With Prettier
In your .prettierrc.js
file just put this content.
const { prettierConfig } = require('@episclera/configkit')
// OR install and import just what you need separately: const prettierConfig = require('@episclera/prettier-config')
module.exports = prettierConfig
With Commitlint
In your commitlint.config.js
file just put this content.
const { commitlintConfig } = require('@episclera/configkit')
// OR install and import just what you need separately: const commitlintConfig = require('@episclera/commitlint-config')
module.exports = commitlintConfig
With Renovate
In your renovate.json
file just put this content. (Do not forgot to connect/install renovate app on GitHub)
{
"extends": ["@episclera"]
}
With Jest
In your jest.config.js
file just put this content.
const { jestConfig } = require('@episclera/configkit')
// OR install and import just what you need separately: const jestConfig = require('@episclera/jest-config')
module.exports = jestConfig
With Eslint
In your .eslintrc.js
file just put this content.
const { eslintConfig } = require('@episclera/configkit')
// OR install and import just what you need separately: const eslintConfig = require('@episclera/eslint-config')
module.exports = eslintConfig
With Stylelint
In your .stylelintrc.js
file just put this content.
const { stylelintConfig } = require('@episclera/configkit')
// OR install and import just what you need separately: const stylelintConfig = require('@episclera/stylelint-config')
module.exports = stylelintConfig
With Babel
In your .babelrc.js
file just put this content.
const { commonBabelConfig } = require('@episclera/configkit')
// OR install and import just what you need separately: const { commonBabelConfig } = require('@episclera/babel-config')
module.exports = commonBabelConfig
// OR you can mix multiple configs with "mergeConfigs" util
const {
commonBabelConfig,
nextBabelConfig,
mergeConfigs,
} = require('@episclera/configkit')
// OR install and import just what you need separately: const { commonBabelConfig, nextBabelConfig } = require('@episclera/babel-config')
// const { mergeConfigs } = require('@episclera/configkit-utils')
module.exports = mergeConfigs(commonBabelConfig, nextBabelConfig)
With Webpack
In your webpack.config.js
file just put this content.
const { commonWebpackConfig } = require('@episclera/configkit')
// OR install and import just what you need separately: const { commonWebpackConfig } = require('@episclera/webpack-config')
module.exports = commonWebpackConfig
// OR you can mix multiple configs with "mergeConfigs" util
const {
commonWebpackConfig,
packageWebpackConfig,
mergeConfigs,
} = require('@episclera/configkit')
// OR install and import just what you need separately: const { commonWebpackConfig, packageWebpackConfig } = require('@episclera/webpack-config')
// const { mergeConfigs } = require('@episclera/configkit-utils')
module.exports = mergeConfigs(commonWebpackConfig, packageWebpackConfig)
With Postcss
In your postcss.config.js
file just put this content.
const { postcssConfig } = require('@episclera/configkit')
// OR install and import just what you need separately: const postcssConfig = require('@episclera/postcss-config')
module.exports = postcssConfig
With Tailwindcss
In your tailwind.config.js
file just put this content.
const { tailwindConfig } = require('@episclera/configkit')
// OR install and import just what you need separately: const tailwindConfig = require('@episclera/tailwind-config')
module.exports = tailwindConfig
With Next
Usage is similar to next-compose-plugins
In your next.config.js
file just put this content.
const { nextConfig } = require('@episclera/configkit')
// OR install and import just what you need separately: const nextConfig = require('@episclera/next-config')
module.exports = nextConfig()
OR if you want to provide custom plugins or next options or webpack options
const { nextConfig } = require('@episclera/configkit')
const { mergeConfigs } = require('@episclera/configkit-utils')
module.exports = nextConfig([myPlugin], {
publicRuntimeConfig: {
HOME_ROUTE_PATH: '/welcome',
},
webpack: config =>
mergeConfigs(config, {
resolve: {
alias: {
myAlias: './myPath',
},
},
}),
})
With NextI18Next
In your next-i18next.config.js
file just put this content.
const { nextI18NextConfig } = require('@episclera/configkit')
// OR install and import just what you need separately: const nextI18NextConfig = require('@episclera/next-i18next-config')
module.exports = nextI18NextConfig
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
Or you can sponsor via Open Collective
Author
@episclera/configkit © Episclera, Released under the MIT License. Authored and maintained by Episclera with help from contributors (list).