-
-
Notifications
You must be signed in to change notification settings - Fork 291
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support overridable configs #58
Closed
Closed
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
04dc160
refactor opts processing
jamestalmage f4e5493
support overrides configs
jamestalmage c08cb40
make the groupConfig test a little more complex
jamestalmage f2caf92
redo changes from #62, which were wiped out in the rebase.
jamestalmage 127678a
fix more regressions from a bad rebase
jamestalmage 057c69d
incorporate PR feedback
jamestalmage 9d915d4
add documentation for Overrides
jamestalmage 34924f8
add test fixture
jamestalmage 4257218
add --no-local flag to the other cli test
jamestalmage 53bcbd2
better language in the readme
jamestalmage 6f86a98
more doc improvements
jamestalmage File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| 'use strict'; | ||
| var path = require('path'); | ||
| var arrify = require('arrify'); | ||
| var pkgConf = require('pkg-conf'); | ||
| var deepAssign = require('deep-assign'); | ||
| var resolveFrom = require('resolve-from'); | ||
| var objectAssign = require('object-assign'); | ||
| var homeOrTmp = require('home-or-tmp'); | ||
| var multimatch = require('multimatch'); | ||
|
|
||
| var DEFAULT_IGNORE = [ | ||
| '**/node_modules/**', | ||
| '**/bower_components/**', | ||
| 'coverage/**', | ||
| '{tmp,temp}/**', | ||
| '**/*.min.js', | ||
| '**/bundle.js', | ||
| 'fixture{-*,}.{js,jsx}', | ||
| '{test/,}fixture{s,}/**', | ||
| 'vendor/**', | ||
| 'dist/**' | ||
| ]; | ||
|
|
||
| var DEFAULT_CONFIG = { | ||
| useEslintrc: false, | ||
| cache: true, | ||
| cacheLocation: path.join(homeOrTmp, '.xo-cache/'), | ||
| baseConfig: { | ||
| extends: 'xo' | ||
| } | ||
| }; | ||
|
|
||
| var DEFAULT_PLUGINS = [ | ||
| 'no-empty-blocks', | ||
| 'no-use-extend-native' | ||
| ]; | ||
|
|
||
| function normalizeOpts(opts) { | ||
| opts = objectAssign({}, opts); | ||
| // alias to help humans | ||
| ['env', 'global', 'ignore', 'plugin', 'rule', 'extend'].forEach(function (singular) { | ||
| var plural = singular + 's'; | ||
| var value = opts[plural] || opts[singular]; | ||
|
|
||
| delete opts[singular]; | ||
|
|
||
| if (value === undefined) { | ||
| return; | ||
| } | ||
|
|
||
| if (singular !== 'rule') { | ||
| value = arrify(value); | ||
| } | ||
|
|
||
| opts[plural] = value; | ||
| }); | ||
|
|
||
| return opts; | ||
| } | ||
|
|
||
| function mergeWithPkgConf(opts) { | ||
| opts = objectAssign({ | ||
| cwd: process.cwd() | ||
| }, opts); | ||
|
|
||
| return objectAssign({}, pkgConf.sync('xo', opts.cwd), opts); | ||
| } | ||
|
|
||
| function buildConfig(opts) { | ||
| var config = deepAssign({}, DEFAULT_CONFIG, { | ||
| envs: opts.envs, | ||
| globals: opts.globals, | ||
| plugins: DEFAULT_PLUGINS.concat(opts.plugins || []), | ||
| rules: opts.rules, | ||
| fix: opts.fix | ||
| }); | ||
|
|
||
| if (!config.rules) { | ||
| config.rules = {}; | ||
| } | ||
|
|
||
| if (opts.space) { | ||
| var spaces = typeof opts.space === 'number' ? opts.space : 2; | ||
| config.rules.indent = [2, spaces, {SwitchCase: 1}]; | ||
| } | ||
|
|
||
| if (opts.semicolon === false) { | ||
| config.rules.semi = [2, 'never']; | ||
| config.rules['semi-spacing'] = [2, {before: false, after: true}]; | ||
| } | ||
|
|
||
| if (opts.esnext) { | ||
| config.baseConfig.extends = 'xo/esnext'; | ||
| } else { | ||
| // always use the Babel parser so it won't throw | ||
| // on esnext features in normal mode | ||
| config.parser = 'babel-eslint'; | ||
| config.plugins = ['babel'].concat(config.plugins); | ||
| config.rules['generator-star-spacing'] = 0; | ||
| config.rules['arrow-parens'] = 0; | ||
| config.rules['object-curly-spacing'] = 0; | ||
| config.rules['babel/object-curly-spacing'] = [2, 'never']; | ||
| } | ||
|
|
||
| if (opts.extends && opts.extends.length > 0) { | ||
| // user's configs must be resolved to their absolute paths | ||
| var configs = opts.extends.map(function (name) { | ||
| if (name.indexOf('eslint-config-') === -1) { | ||
| name = 'eslint-config-' + name; | ||
| } | ||
|
|
||
| return resolveFrom(opts.cwd, name); | ||
| }); | ||
|
|
||
| configs.unshift(config.baseConfig.extends); | ||
|
|
||
| config.baseConfig.extends = configs; | ||
| } | ||
|
|
||
| return config; | ||
| } | ||
|
|
||
| // Builds a list of overrides for a particular path, and a hash value. | ||
| // The hash value is a binary representation of which elements in the `overrides` array apply to the path. | ||
| // | ||
| // If overrides.length === 4, and only the first and third elements apply, then our hash is: 1010 (in binary) | ||
| function findApplicableOverrides(path, overrides) { | ||
| var hash = 0; | ||
| var applicable = []; | ||
| overrides.forEach(function (override) { | ||
| hash <<= 1; | ||
| if (multimatch(path, override.files).length > 0) { | ||
| applicable.push(override); | ||
| hash |= 1; | ||
| } | ||
| }); | ||
| return { | ||
| hash: hash, | ||
| applicable: applicable | ||
| }; | ||
| } | ||
|
|
||
| // Creates grouped sets of merged options together with the paths they apply to. | ||
| function groupConfigs(paths, baseOptions, overrides) { | ||
| var map = {}; | ||
| var arr = []; | ||
|
|
||
| paths.forEach(function (x) { | ||
| var data = findApplicableOverrides(x, overrides); | ||
| if (!map[data.hash]) { | ||
| var mergedOpts = deepAssign.apply(null, [{}, baseOptions].concat(data.applicable)); | ||
| delete mergedOpts.files; | ||
| arr.push(map[data.hash] = { | ||
| opts: mergedOpts, | ||
| paths: [] | ||
| }); | ||
| } | ||
| map[data.hash].paths.push(x); | ||
| }); | ||
|
|
||
| return arr; | ||
| } | ||
|
|
||
| function preprocess(opts) { | ||
| opts = mergeWithPkgConf(opts); | ||
| opts = normalizeOpts(opts); | ||
| opts.ignores = DEFAULT_IGNORE.concat(opts.ignores || []); | ||
| return opts; | ||
| } | ||
|
|
||
| exports.DEFAULT_IGNORE = DEFAULT_IGNORE; | ||
| exports.DEFAULT_CONFIG = DEFAULT_CONFIG; | ||
| exports.mergeWithPkgConf = mergeWithPkgConf; | ||
| exports.normalizeOpts = normalizeOpts; | ||
| exports.buildConfig = buildConfig; | ||
| exports.findApplicableOverrides = findApplicableOverrides; | ||
| exports.groupConfigs = groupConfigs; | ||
| exports.preprocess = preprocess; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is where the merging of every applicable "overrides" happens. Is the
deepAssignlogic sufficient here?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes