Ghost/.eslintrc.js
Hannah Wolfe 2f1123d6ca
Added eslint rule to prevent usage of new Error()
- we have our own error library that should always be used to wrap errors in useful info
- therefore instead of new Error() we should always be using errors.SomeError from @tryghost/error
2021-06-08 11:51:49 +01:00

78 lines
2.3 KiB
JavaScript

const path = require('path');
module.exports = {
env: {
es6: true,
node: true
},
plugins: ['ghost'],
extends: [
'plugin:ghost/node'
],
rules: {
// @TODO: remove this rule once it's turned into "error" in the base plugin
'no-shadow': 'error',
'no-var': 'error',
'one-var': [2, 'never'],
'no-restricted-syntax': ['warn',
{
selector: 'NewExpression[callee.name=\'Error\']',
message: 'Direct calls to new Error() are not allowed. Please use @tryghost/errors.'
}]
},
overrides: [
{
files: '**/index.js',
rules: {
'max-lines': ['warn', {skipBlankLines: true, skipComments: true, max: 50}]
}
},
{
files: 'core/server/api/canary/*',
rules: {
'ghost/ghost-custom/max-api-complexity': 'warn'
}
},
{
files: 'core/shared/**',
rules: {
'ghost/node/no-restricted-require': ['error', [
{
name: path.resolve(__dirname, 'core/server/**'),
message: 'Invalid require of core/server from core/shared.'
},
{
name: path.resolve(__dirname, 'core/server/**'),
message: 'Invalid require of core/frontend from core/shared.'
}
]]
}
},
/**
* @TODO: enable these soon
*/
{
files: 'core/frontend/**',
rules: {
'ghost/node/no-restricted-require': ['off', [
{
name: path.resolve(__dirname, 'core/server/**'),
message: 'Invalid require of core/server from core/frontend.'
}
]]
}
},
{
files: 'core/server/**',
rules: {
'ghost/node/no-restricted-require': ['off', [
{
name: path.resolve(__dirname, 'core/frontend/**'),
message: 'Invalid require of core/frontend from core/server.'
}
]]
}
}
]
};