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

Omit filenames containing asterisks #32

Closed
wants to merge 1 commit into from
Closed
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
13 changes: 13 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ const defaultRules = [
'core.+([0-9])',
]

// There may be others, but :?|<> are handled by node-tar
const nameIsBadForWindows = file => /\*/.test(file)

// a decorator that applies our custom rules to an ignore walker
const npmWalker = Class => class Walker extends Class {
constructor (opt) {
Expand Down Expand Up @@ -191,6 +194,16 @@ const npmWalker = Class => class Walker extends Class {
then()
}

// override parent stat function to completely skip any filenames
// that will break windows entirely.
// XXX(isaacs) Next major version should make this an error instead.
stat (entry, file, dir, then) {
if (nameIsBadForWindows(entry))
then()
else
super.stat(entry, file, dir, then)
}

// override parent onstat function to nix all symlinks
onstat (st, entry, file, dir, then) {
if (st.isSymbolicLink())
Expand Down
122 changes: 122 additions & 0 deletions test/star-names.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
'use strict'
const fs = require('fs')

const readdir = fs.readdir
fs.readdir = (path, cb) => {
readdir(path, (er, entries) => {
if (er)
cb(er)
else
cb(null, entries.concat('made*of*stars'))
})
}

const readdirSync = fs.readdirSync
fs.readdirSync = path => readdirSync(path).concat('made*of*stars')

const path = require('path')

const mkdirp = require('mkdirp')
const rimraf = require('rimraf')
const t = require('tap')

const pack = require('../')

const pkg = path.join(__dirname, path.basename(__filename, '.js'))
t.teardown(_ => rimraf.sync(pkg))

const elfJS = `
module.exports = elf =>
console.log("i'm a elf")
`

const json = {
'name': 'test-package',
'version': '3.1.4',
'main': 'elf.js'
}

const expect = [
'package.json',
'elf.js',
'deps/foo/config/config.gypi'
]

t.test('setup', t => {
rimraf.sync(pkg)
mkdirp.sync(pkg)
fs.writeFileSync(
path.join(pkg, 'package.json'),
JSON.stringify(json, null, 2)
)

fs.writeFileSync(
path.join(pkg, 'elf.js'),
elfJS
)

fs.writeFileSync(
path.join(pkg, '.npmrc'),
'packaged=false'
)

fs.writeFileSync(
path.join(pkg, '.npmignore'),
'.npmignore\ndummy\npackage.json'
)

fs.writeFileSync(
path.join(pkg, 'dummy'),
'foo'
)

// empty dir should be ignored
mkdirp.sync(pkg + '/this/dir/is/empty/and/ignored')

const buildDir = path.join(pkg, 'build')
mkdirp.sync(buildDir)
fs.writeFileSync(
path.join(buildDir, 'config.gypi'),
"i_wont_be_included='with any luck'"
)

const depscfg = path.join(pkg, 'deps/foo/config')
mkdirp.sync(depscfg)
fs.writeFileSync(
path.join(depscfg, 'config.gypi'),
"i_will_be_included='with any luck'"
)

fs.writeFileSync(
path.join(buildDir, 'npm-debug.log'),
'0 lol\n'
)

const gitDir = path.join(pkg, '.git')
mkdirp.sync(gitDir)
fs.writeFileSync(
path.join(gitDir, 'gitstub'),
"won't fool git, also won't be included"
)

const historyDir = path.join(pkg, 'node_modules/history')
mkdirp.sync(historyDir)
fs.writeFileSync(
path.join(historyDir, 'README.md'),
"please don't include me"
)

t.end()
})

t.test('follows npm package ignoring rules', function (t) {
const check = (files, t) => {
t.same(files, expect)
t.end()
}

t.test('sync', t => check(pack.sync({ path: pkg }), t))
t.test('async', t => pack({ path: pkg }).then(files => check(files, t)))

t.end()
})