Skip to content
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

Ignore paths from .gitignore #147

Merged
merged 17 commits into from
Oct 11, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion options-manager.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ const deepAssign = require('deep-assign');
const multimatch = require('multimatch');
const resolveFrom = require('resolve-from');
const pathExists = require('path-exists');
const parseGitignore = require('parse-gitignore');
const globby = require('globby');

const DEFAULT_IGNORE = [
'**/node_modules/**',
Expand Down Expand Up @@ -203,11 +205,29 @@ function groupConfigs(paths, baseOptions, overrides) {
return arr;
}

function getIgnores(opts) {
opts.ignores = DEFAULT_IGNORE.concat(opts.ignores || []);
const gitignores = globby.sync('**/.gitignore', {ignore: opts.ignores, cwd: opts.cwd || process.cwd()});
const ignores = gitignores
.map(pathToGitignore => {
const patterns = parseGitignore(pathToGitignore);
const base = path.dirname(pathToGitignore);

return patterns.map(file => path.join(base, file));
})
.reduce((a, b) => a.concat(b), []);

opts.ignores = opts.ignores.concat(ignores);

return opts;
}

function preprocess(opts) {
opts = mergeWithPkgConf(opts);
opts = normalizeOpts(opts);
opts.ignores = DEFAULT_IGNORE.concat(opts.ignores || []);
opts = getIgnores(opts);
opts.extensions = DEFAULT_EXTENSION.concat(opts.extensions || []);

return opts;
}

Expand All @@ -221,3 +241,4 @@ exports.mergeApplicableOverrides = mergeApplicableOverrides;
exports.groupConfigs = groupConfigs;
exports.preprocess = preprocess;
exports.emptyOptions = emptyOptions;
exports.getIgnores = getIgnores;
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@
"has-flag": "^2.0.0",
"meow": "^3.4.2",
"multimatch": "^2.1.0",
"parse-gitignore": "^0.3.1",
"path-exists": "^3.0.0",
"pkg-conf": "^2.0.0",
"resolve-cwd": "^1.0.0",
Expand Down
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ Additional global variables your code accesses during execution.

Type: `Array`

Some [paths](https://github.com/sindresorhus/xo/blob/master/options-manager.js) are ignored by default. Additional ignores can be added here.
Some [paths](https://github.com/sindresorhus/xo/blob/master/options-manager.js) are ignored by default, including paths in .gitignore. Additional ignores can be added here.

### space

Expand Down
2 changes: 2 additions & 0 deletions test/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# This is a test .gitignore.
foo/
1 change: 1 addition & 0 deletions test/bar/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
foo.js
1 change: 1 addition & 0 deletions test/bar/foobar/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
bar.js
11 changes: 11 additions & 0 deletions test/cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,17 @@ test.failing('ignores fixture', async t => {
t.throws(execa('../../../cli.js', ['--no-local'], {cwd}));
});

test('ignore files in .gitignore', async t => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be good if this test was duplicated as an API test too (using the cwd option).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this should be an API test?
What are the API tests for?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To make sure the cwd option is adhered to. In the CLI test it just uses process.cwd(). API tests are a lot faster to run too. Long-term, I'm going to convert many of the CLI tests to API tests.

I've merged this now, but would be nice if you could submit an API test for this.

const cwd = path.join(__dirname, 'fixtures/gitignore');

try {
await execa('../../../cli.js', ['--no-local'], {cwd});
} catch (err) {
t.is(err.stdout.indexOf('foo.js'), -1);
t.true(err.stdout.indexOf('bar.js') !== -1);
}
});

test('supports being extended with a shareable config', async () => {
const cwd = path.join(__dirname, 'fixtures/project');
await execa('../../../cli.js', ['--no-local'], {cwd});
Expand Down
5 changes: 5 additions & 0 deletions test/fixtures/gitignore/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
'use strict'

module.exports = function (foo) {
return foo + 'bar'
}
1 change: 1 addition & 0 deletions test/fixtures/gitignore/test/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
foo.js
6 changes: 6 additions & 0 deletions test/fixtures/gitignore/test/bar.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import test from 'ava'
import fn from '../'

test(t => {
t.is(fn('foo'), fn('foobar'))
})
6 changes: 6 additions & 0 deletions test/fixtures/gitignore/test/foo.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import test from 'ava'
import fn from '../'

test(t => {
t.is(fn('foo'), fn('foobar'))
})
18 changes: 18 additions & 0 deletions test/options-manager.js
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,24 @@ test('groupConfigs', t => {
}));
});

test('gitignore', t => {
const result = manager.getIgnores({});
t.not(result.ignores.indexOf(path.join('foo', '**')), -1);
t.not(result.ignores.indexOf(path.join('bar', 'foo.js')), -1);
});

test('ignore ignored .gitignore', t => {
const opts = {
ignores: [
'**/foobar/**'
]
};

const result = manager.getIgnores(opts);

t.is(result.ignores.indexOf(path.join('bar', 'foobar', 'bar.js')), -1);
});

test('mergeWithPkgConf: use child if closest', t => {
const cwd = path.resolve('fixtures', 'nested', 'child');
const result = manager.mergeWithPkgConf({cwd});
Expand Down