30 Commits
Author SHA1 Message Date
Gajus Kuizinas be0e6fdc75 1.0.0 2016-11-01 15:59:44 +00:00
Gajus Kuizinas 91c2e4eae3 feat: use comment to target files (fixes #5) 2016-11-01 15:58:31 +00:00
Gajus Kuizinas c41edde1cd docs: update documentation to reflect new option names (fixes #10) 2016-11-01 15:57:08 +00:00
Gajus Kuizinas d05b635834 feat: add alias -u to --update (fixes #10) 2016-11-01 15:50:18 +00:00
Gajus Kuizinas 9278b25dcd feat: rename --update-index to --update (fixes #10) 2016-11-01 15:50:02 +00:00
Gajus Kuizinas 3c5e96f8c0 chore: ignore ./test instead of ./tests 2016-11-01 15:46:36 +00:00
Gajus Kuizinas 696b817ce4 chore: add missing babel plugins 2016-11-01 15:45:29 +00:00
Gajus Kuizinas 2faeba74b3 chore: fix the build script 2016-11-01 15:36:19 +00:00
Gajus Kuizinas eac728be0b chore: add missing babel plugins 2016-11-01 15:36:09 +00:00
Gajus Kuizinas 2fa0d6635f chore: update dependencies 2016-11-01 15:33:28 +00:00
Gajus Kuizinas 08b9abc45a chore: define .travis.yml test scripts 2016-11-01 15:33:05 +00:00
Gajus Kuizinas a61cb3a14e chore: add .eslintignore 2016-11-01 15:31:41 +00:00
Gajus Kuizinas 272a836c96 chore: rename ./tests to ./test 2016-11-01 15:31:00 +00:00
Gajus Kuizinas 78109764f7 chore: move ./fixtures folder under ./tests 2016-11-01 15:30:04 +00:00
Gajus Kuizinas 335152f0d4 chore: replace pragmatist with Mocha, ESLint, Babel 2016-11-01 15:27:12 +00:00
Gajus Kuizinas 858085656b style: fix code style 2016-11-01 15:26:29 +00:00
Gajus Kuizinas 7990da993f chore: define minimum node requirement v5 2016-11-01 14:55:36 +00:00
Gajus Kuizinas 057949b3db chore: define .eslintrc 2016-11-01 14:43:19 +00:00
Gajus Kuizinas 9579637f8e chore: enable tests for node.js 5, 6 and 7 2016-11-01 14:40:09 +00:00
Gajus Kuizinas 0fa96772a8 chore: define .editorconfig 2016-11-01 14:39:30 +00:00
Gajus Kuizinas 99fd807dfb 0.1.3 2016-04-10 18:03:22 +01:00
Gajus Kuizinas 67be5ec70c Updated dependencies. 2016-04-10 18:03:16 +01:00
Gajus Kuizinas a8a5332d5c Code style preferences. 2016-03-19 13:01:04 +02:00
Gajus Kuizinas 329533a130 Use type assertions for tests. 2016-03-19 12:56:31 +02:00
Gajus Kuizinas c5f0452f10 Updated dependencies. 2016-03-19 12:54:13 +02:00
Gajus Kuizinas 00c8312dc1 0.1.2 2016-01-29 21:40:21 +00:00
Gajus Kuizinas 36ea8228ee Name can include an underscore character. 2016-01-29 21:40:16 +00:00
Gajus Kuizinas f41753b978 Added example to the docs. 2016-01-29 13:22:39 +00:00
Gajus Kuizinas a23c3ad866 0.1.1 2016-01-29 13:15:56 +00:00
Gajus Kuizinas dc80afa816 Corrected dependencies. 2016-01-29 13:15:50 +00:00
90 changed files with 594 additions and 568 deletions
+8
View File
@@ -0,0 +1,8 @@
{
"plugins": [
"transform-es2015-modules-commonjs",
"transform-export-extensions",
"transform-es2015-destructuring",
"transform-es2015-parameters"
]
}
+7
View File
@@ -0,0 +1,7 @@
root = true
[*]
end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 2
+1
View File
@@ -0,0 +1 @@
./test/fixtures
+3
View File
@@ -0,0 +1,3 @@
{
"extends": "canonical"
}
+5 -2
View File
@@ -1,9 +1,12 @@
node_modules
coverage coverage
dist dist
node_modules
*.log *.log
.* .*
!.babelrc
!.editorconfig
!.eslintignore
!.eslintrc
!.gitignore !.gitignore
!.npmignore !.npmignore
!.babelrc
!.travis.yml !.travis.yml
+2 -2
View File
@@ -1,6 +1,6 @@
coverage
fixtures fixtures
src src
tests test
coverage
.* .*
*.log *.log
+7 -2
View File
@@ -1,7 +1,12 @@
language: node_js language: node_js
node_js: node_js:
- '5.0' - 7
- '4.0' - 6
- 5
scripts:
- npm run test
- npm run lint
- npm run build
notifications: notifications:
email: false email: false
sudo: false sudo: false
+74 -10
View File
@@ -6,6 +6,72 @@
`create-index` program creates (and maintains) ES6 `./index.js` file in target directories that imports and exports sibling files and directories. `create-index` program creates (and maintains) ES6 `./index.js` file in target directories that imports and exports sibling files and directories.
## Example
```sh
> tree ./
./
├── bar.js
└── foo.js
0 directories, 2 files
> create-index ./
[13:17:34] Target directories [ './' ]
[13:17:34] Update index: false
[13:17:34] ./index.js [created index]
[13:17:34] Done
> tree
.
├── bar.js
├── foo.js
└── index.js
0 directories, 3 files
```
This created `index.js` with:
```js
// @create-index
export bar from './bar.js';
export foo from './foo.js';
```
Lets create a new file and re-run `create-index`:
```js
> touch baz.js
> tree ./
./
├── bar.js
├── baz.js
├── foo.js
└── index.js
0 directories, 4 files
> create-index ./
[13:21:55] Target directories [ './' ]
[13:21:55] Update index: false
[13:21:55] ./index.js [updated index]
[13:21:55] Done
```
This have updated `index.js` file:
```js
// @create-index
export bar from './bar.js';
export baz from './baz.js';
export foo from './foo.js';
```
## Usage ## Usage
### Using CLI Program ### Using CLI Program
@@ -16,20 +82,18 @@ npm install create-index
create-index --help create-index --help
Options: Options:
--update-index Recursively iterates target directories looking for "index.js" --update, -u Recursively iterates target directories looking for "index.js"
files that start with "'create index';\n" (create-index index files that start with "'create index';\n" (create-index index
file). Updates found index files. Does not create new index file). Updates found index files. Does not create new index
files. [boolean] [default: false] files. [boolean] [default: false]
Examples: Examples:
create-index ./src ./src/utilities Creates or updates an existing create-index ./src ./src/utilities Creates or updates an existing
create-index index file in the create-index index file in the target
target (./src, ./src/utilities) (./src, ./src/utilities) directories.
directories. create-index --update ./src ./tests Finds all create-index index files in the
create-index --update-index ./src Finds all create-index index files target directories and descending
./tests in the target directories and directories. Updates found index files.
descending directories. Updates
found index files.
``` ```
### Using `create-index` Programmatically ### Using `create-index` Programmatically
@@ -88,10 +152,10 @@ Note that the `writeIndex` function is synchronous.
If there is no `./index.js`, it will create a new file, e.g. If there is no `./index.js`, it will create a new file, e.g.
```js ```js
'create index'; // @create-index
``` ```
Created index file must start with `'create index';\n\n`. This is used to make sure that `create-index` does not accidentally overwrite your local files. Created index file must start with `// @create-index\n\n`. This is used to make sure that `create-index` does not accidentally overwrite your local files.
If there are sibling files, index file will `import` them and `export`, e.g. If there are sibling files, index file will `import` them and `export`, e.g.
@@ -1 +0,0 @@
'create index';
@@ -1 +0,0 @@
// 'create index';
@@ -1 +0,0 @@
'create index';
@@ -1 +0,0 @@
// 'create index';
@@ -1 +0,0 @@
'create index';
@@ -1 +0,0 @@
'create index';
@@ -1 +0,0 @@
'create index';
@@ -1 +0,0 @@
'create index';
@@ -1 +0,0 @@
'create index';
@@ -1 +0,0 @@
'create index';
@@ -1 +0,0 @@
'create index';
@@ -1 +0,0 @@
'create index';
@@ -1 +0,0 @@
'create index';
@@ -1 +0,0 @@
'create index';
@@ -1 +0,0 @@
'create index';
@@ -1 +0,0 @@
'create index';
@@ -1 +0,0 @@
'create index';
@@ -1 +0,0 @@
'create index';
@@ -1 +0,0 @@
'create index';
-1
View File
@@ -1 +0,0 @@
'create index';
-1
View File
@@ -1 +0,0 @@
'create index';
+21 -15
View File
@@ -1,7 +1,7 @@
{ {
"name": "create-index", "name": "create-index",
"description": "Creates ES6 ./index.js file in target directories that imports and exports all sibling files and directories.", "description": "Creates ES6 ./index.js file in target directories that imports and exports all sibling files and directories.",
"version": "0.1.0", "version": "1.0.0",
"main": "./dist/index.js", "main": "./dist/index.js",
"bin": "./dist/bin/create-index.js", "bin": "./dist/bin/create-index.js",
"repository": { "repository": {
@@ -13,6 +13,9 @@
"import", "import",
"export" "export"
], ],
"engines": {
"node": ">=5"
},
"author": { "author": {
"name": "Gajus Kuizinas", "name": "Gajus Kuizinas",
"email": "gajus@gajus.com", "email": "gajus@gajus.com",
@@ -20,25 +23,28 @@
}, },
"license": "BSD-3-Clause", "license": "BSD-3-Clause",
"scripts": { "scripts": {
"pragmatist": "node ./node_modules/.bin/pragmatist --es5", "lint": "eslint ./src ./tests",
"lint": "npm run pragmatist lint", "test": "mocha --compilers js:babel-register",
"test": "npm run pragmatist test", "build": "babel --source-maps --copy-files ./src --out-dir ./dist",
"build": "npm run pragmatist build",
"watch": "npm run pragmatist watch",
"watch-lint": "npm run pragmatist watch-lint",
"watch-test": "npm run pragmatist watch-test",
"watch-build": "npm run pragmatist watch-build",
"create-index": "node ./dist/bin/create-index ./src/utilities" "create-index": "node ./dist/bin/create-index ./src/utilities"
}, },
"devDependencies": { "devDependencies": {
"babel-cli": "^6.18.0",
"babel-plugin-transform-es2015-destructuring": "^6.18.0",
"babel-plugin-transform-es2015-modules-commonjs": "^6.18.0",
"babel-plugin-transform-es2015-parameters": "^6.18.0",
"babel-plugin-transform-export-extensions": "^6.8.0",
"babel-register": "^6.18.0",
"chai": "^3.5.0", "chai": "^3.5.0",
"chalk": "^1.1.1", "eslint": "^3.9.1",
"moment": "^2.11.1", "eslint-config-canonical": "^4.0.0",
"pragmatist": "^3.0.3" "mocha": "^3.1.2"
}, },
"dependencies": { "dependencies": {
"glob": "^6.0.4", "glob": "^7.1.1",
"lodash": "^4.0.1", "lodash": "^4.16.6",
"yargs": "^4.0.0-alpha1" "yargs": "^6.3.0",
"chalk": "^1.1.3",
"moment": "^2.15.2"
} }
} }
+5 -6
View File
@@ -3,21 +3,20 @@
import yargs from 'yargs'; import yargs from 'yargs';
import { import {
writeIndexCli writeIndexCli
} from './../utilities'; } from '../utilities';
let argv; const argv = yargs
argv = yargs
.demand(1) .demand(1)
.options({ .options({
'update-index': { 'update': {
alias: 'u',
default: false, default: false,
description: 'Recursively iterates target directories looking for "index.js" files that start with "\'create index\';\\n" (create-index index file). Updates found index files. Does not create new index files.', description: 'Recursively iterates target directories looking for "index.js" files that start with "\'create index\';\\n" (create-index index file). Updates found index files. Does not create new index files.',
type: 'boolean' type: 'boolean'
} }
}) })
.example('create-index ./src ./src/utilities', 'Creates or updates an existing create-index index file in the target (./src, ./src/utilities) directories.') .example('create-index ./src ./src/utilities', 'Creates or updates an existing create-index index file in the target (./src, ./src/utilities) directories.')
.example('create-index --update-index ./src ./tests', 'Finds all create-index index files in the target directories and descending directories. Updates found index files.') .example('create-index --update ./src ./tests', 'Finds all create-index index files in the target directories and descending directories. Updates found index files.')
.argv; .argv;
writeIndexCli(argv._, { writeIndexCli(argv._, {
+5 -11
View File
@@ -1,12 +1,7 @@
import _ from 'lodash'; import _ from 'lodash';
let buildExportBlock, const safeVariableName = (fileName) => {
safeVariableName; const indexOfDot = fileName.indexOf('.');
safeVariableName = (fileName) => {
let indexOfDot;
indexOfDot = fileName.indexOf('.');
if (indexOfDot === -1) { if (indexOfDot === -1) {
return fileName; return fileName;
@@ -15,7 +10,7 @@ safeVariableName = (fileName) => {
} }
}; };
buildExportBlock = (files) => { const buildExportBlock = (files) => {
let importBlock; let importBlock;
importBlock = _.map(files, (fileName) => { importBlock = _.map(files, (fileName) => {
@@ -28,13 +23,12 @@ buildExportBlock = (files) => {
}; };
export default (filePaths) => { export default (filePaths) => {
let code, let code;
sortedFilePaths;
code = '\'create index\';\n\n'; code = '\'create index\';\n\n';
if (filePaths.length) { if (filePaths.length) {
sortedFilePaths = filePaths.sort(); const sortedFilePaths = filePaths.sort();
code += buildExportBlock(sortedFilePaths) + '\n\n'; code += buildExportBlock(sortedFilePaths) + '\n\n';
} }
+3 -3
View File
@@ -1,6 +1,6 @@
import path from 'path';
import _ from 'lodash'; import _ from 'lodash';
import glob from 'glob'; import glob from 'glob';
import path from 'path';
import validateTargetDirectory from './validateTargetDirectory'; import validateTargetDirectory from './validateTargetDirectory';
export default (directoryPath) => { export default (directoryPath) => {
@@ -13,11 +13,11 @@ export default (directoryPath) => {
validateTargetDirectory(path.dirname(targetDirectoryPath)); validateTargetDirectory(path.dirname(targetDirectoryPath));
return true; return true;
/* eslint-disable no-empty */
// eslint-disable-next-line no-empty
} catch (error) { } catch (error) {
} }
/* eslint-enable no-empty */
return false; return false;
}); });
+1
View File
@@ -4,5 +4,6 @@ import moment from 'moment';
export default (...append) => { export default (...append) => {
/* eslint-disable no-console */ /* eslint-disable no-console */
console.log(chalk.dim('[' + moment().format('HH:mm:ss') + ']'), ...append); console.log(chalk.dim('[' + moment().format('HH:mm:ss') + ']'), ...append);
/* eslint-enable no-console */ /* eslint-enable no-console */
}; };
+12 -28
View File
@@ -1,18 +1,10 @@
import fs from 'fs'; import fs from 'fs';
import _ from 'lodash';
import path from 'path'; import path from 'path';
import _ from 'lodash';
import validateTargetDirectory from './validateTargetDirectory'; import validateTargetDirectory from './validateTargetDirectory';
let hasIndex, const hasIndex = (directoryPath) => {
hasMultipleExtensions, const indexPath = path.resolve(directoryPath, 'index.js');
hasNoExtension,
isSafeName,
removeDuplicates;
hasIndex = (directoryPath) => {
let indexPath;
indexPath = path.resolve(directoryPath, 'index.js');
try { try {
fs.statSync(indexPath); fs.statSync(indexPath);
@@ -23,27 +15,23 @@ hasIndex = (directoryPath) => {
} }
}; };
hasNoExtension = (fileName) => { const hasNoExtension = (fileName) => {
let matches; const matches = fileName.match(/\./g);
matches = fileName.match(/\./g);
return !matches; return !matches;
}; };
hasMultipleExtensions = (fileName) => { const hasMultipleExtensions = (fileName) => {
let matches; const matches = fileName.match(/\./g);
matches = fileName.match(/\./g);
return matches && matches.length > 1; return matches && matches.length > 1;
}; };
isSafeName = (fileName) => { const isSafeName = (fileName) => {
return /^[a-z][a-z0-9\.]+$/i.test(fileName); return /^[a-z][a-z0-9._]+$/i.test(fileName);
}; };
removeDuplicates = (files) => { const removeDuplicates = (files) => {
return _.filter(files, (fileName) => { return _.filter(files, (fileName) => {
return !_.includes(files, fileName + '.js'); return !_.includes(files, fileName + '.js');
}); });
@@ -57,12 +45,8 @@ export default (directoryPath) => {
children = fs.readdirSync(directoryPath); children = fs.readdirSync(directoryPath);
children = _.filter(children, (fileName) => { children = _.filter(children, (fileName) => {
let absolutePath, const absolutePath = path.resolve(directoryPath, fileName);
isDirectory; const isDirectory = fs.statSync(absolutePath).isDirectory();
absolutePath = path.resolve(directoryPath, fileName);
isDirectory = fs.statSync(absolutePath).isDirectory();
if (!isSafeName(fileName)) { if (!isSafeName(fileName)) {
return false; return false;
+5 -7
View File
@@ -1,11 +1,9 @@
import _ from 'lodash';
import fs from 'fs'; import fs from 'fs';
import path from 'path'; import path from 'path';
import _ from 'lodash';
export default (targetDirectory) => { export default (targetDirectory) => {
let indexFile, let stats;
indexFilePath,
stats;
try { try {
stats = fs.statSync(targetDirectory); stats = fs.statSync(targetDirectory);
@@ -17,7 +15,7 @@ export default (targetDirectory) => {
throw new Error('"' + targetDirectory + '" is not a directory.'); throw new Error('"' + targetDirectory + '" is not a directory.');
} }
indexFilePath = path.resolve(targetDirectory, './index.js'); const indexFilePath = path.resolve(targetDirectory, './index.js');
try { try {
fs.statSync(indexFilePath); fs.statSync(indexFilePath);
@@ -25,9 +23,9 @@ export default (targetDirectory) => {
return true; return true;
} }
indexFile = fs.readFileSync(indexFilePath, 'utf8'); const indexFile = fs.readFileSync(indexFilePath, 'utf8');
if (!_.startsWith(indexFile, '\'create index\';\n')) { if (!_.startsWith(indexFile, '// @create-index\n')) {
throw new Error('"' + indexFilePath + '" unsafe index.'); throw new Error('"' + indexFilePath + '" unsafe index.');
} }
+6 -14
View File
@@ -1,30 +1,22 @@
import _ from 'lodash';
import createIndexCode from './createIndexCode';
import fs from 'fs'; import fs from 'fs';
import path from 'path'; import path from 'path';
import _ from 'lodash';
import createIndexCode from './createIndexCode';
import validateTargetDirectory from './validateTargetDirectory'; import validateTargetDirectory from './validateTargetDirectory';
import readDirectory from './readDirectory'; import readDirectory from './readDirectory';
import sortByDepth from './sortByDepth'; import sortByDepth from './sortByDepth';
export default (directoryPaths) => { export default (directoryPaths) => {
let sortedDirectoryPaths; const sortedDirectoryPaths = sortByDepth(directoryPaths);
sortedDirectoryPaths = sortByDepth(directoryPaths);
_.forEach(sortedDirectoryPaths, (directoryPath) => { _.forEach(sortedDirectoryPaths, (directoryPath) => {
validateTargetDirectory(directoryPath); validateTargetDirectory(directoryPath);
}); });
_.forEach(sortedDirectoryPaths, (directoryPath) => { _.forEach(sortedDirectoryPaths, (directoryPath) => {
let indexCode, const siblings = readDirectory(directoryPath);
indexFilePath, const indexCode = createIndexCode(siblings);
siblings; const indexFilePath = path.resolve(directoryPath, 'index.js');
siblings = readDirectory(directoryPath);
indexCode = createIndexCode(siblings);
indexFilePath = path.resolve(directoryPath, 'index.js');
fs.writeFileSync(indexFilePath, indexCode); fs.writeFileSync(indexFilePath, indexCode);
}); });
+9 -10
View File
@@ -1,13 +1,13 @@
import _ from 'lodash';
import createIndexCode from './createIndexCode';
import fs from 'fs'; import fs from 'fs';
import path from 'path'; import path from 'path';
import _ from 'lodash';
import chalk from 'chalk';
import createIndexCode from './createIndexCode';
import validateTargetDirectory from './validateTargetDirectory'; import validateTargetDirectory from './validateTargetDirectory';
import readDirectory from './readDirectory'; import readDirectory from './readDirectory';
import sortByDepth from './sortByDepth'; import sortByDepth from './sortByDepth';
import log from './log'; import log from './log';
import findIndexFiles from './findIndexFiles'; import findIndexFiles from './findIndexFiles';
import chalk from 'chalk';
export default (directoryPaths, options = {}) => { export default (directoryPaths, options = {}) => {
let sortedDirectoryPaths; let sortedDirectoryPaths;
@@ -31,23 +31,22 @@ export default (directoryPaths, options = {}) => {
}); });
_.forEach(sortedDirectoryPaths, (directoryPath) => { _.forEach(sortedDirectoryPaths, (directoryPath) => {
let existingIndexCode, let existingIndexCode;
indexCode,
indexFilePath,
siblings;
siblings = readDirectory(directoryPath); const siblings = readDirectory(directoryPath);
indexCode = createIndexCode(siblings); const indexCode = createIndexCode(siblings);
indexFilePath = path.resolve(directoryPath, 'index.js'); const indexFilePath = path.resolve(directoryPath, 'index.js');
try { try {
existingIndexCode = fs.readFileSync(indexFilePath, 'utf8'); existingIndexCode = fs.readFileSync(indexFilePath, 'utf8');
/* eslint-disable no-empty */ /* eslint-disable no-empty */
} catch (error) { } catch (error) {
} }
/* eslint-enable no-empty */ /* eslint-enable no-empty */
fs.writeFileSync(indexFilePath, indexCode); fs.writeFileSync(indexFilePath, indexCode);
+59
View File
@@ -0,0 +1,59 @@
/* eslint-disable no-restricted-syntax */
import {
expect
} from 'chai';
import createIndexCode from '../src/utilities/createIndexCode';
import codeExample from './codeExample';
describe('createIndexCode()', () => {
it('describes no children', () => {
const indexCode = createIndexCode([]);
expect(indexCode).to.equal(codeExample(`
'create index';
`));
});
it('describes a single child', () => {
const indexCode = createIndexCode(['foo']);
expect(indexCode).to.equal(codeExample(`
'create index';
export foo from './foo';
`));
});
it('describes multiple children', () => {
const indexCode = createIndexCode(['bar', 'foo']);
expect(indexCode).to.equal(codeExample(`
'create index';
export bar from './bar';
export foo from './foo';
`));
});
context('file with extension', () => {
it('removes the extension from the export statement', () => {
const indexCode = createIndexCode(['foo.js']);
expect(indexCode).to.equal(codeExample(`
'create index';
export foo from './foo.js';
`));
});
});
context('multiple, unsorted', () => {
it('sorts the files', () => {
const indexCode = createIndexCode(['foo', 'bar']);
expect(indexCode).to.equal(codeExample(`
'create index';
export bar from './bar';
export foo from './foo';
`));
});
});
});
+19
View File
@@ -0,0 +1,19 @@
import path from 'path';
import {
expect
} from 'chai';
import glob from 'glob';
import findIndexFiles from '../src/utilities/findIndexFiles';
const fixturesPath = path.resolve(__dirname, '../../fixtures/find-index-files');
describe('findIndexFiles()', () => {
it('finds only the directories that have an existing valid index file', () => {
let names;
names = findIndexFiles(path.resolve(fixturesPath));
names = names.sort();
expect(names).to.deep.equal(glob.sync(path.resolve(fixturesPath, '**/find-*')));
});
});
@@ -0,0 +1 @@
// @create-index
+1
View File
@@ -0,0 +1 @@
// create-index
+1
View File
@@ -0,0 +1 @@
// @create-index
@@ -0,0 +1 @@
// create-index
+1
View File
@@ -0,0 +1 @@
// @create-index
+1
View File
@@ -0,0 +1 @@
// @create-index
@@ -0,0 +1 @@
// @create-index
@@ -0,0 +1 @@
// @create-index
@@ -0,0 +1 @@
// @create-index
@@ -0,0 +1 @@
// @create-index
@@ -0,0 +1 @@
// @create-index
@@ -0,0 +1 @@
// @create-index
@@ -0,0 +1 @@
// @create-index
@@ -0,0 +1 @@
// @create-index
@@ -0,0 +1 @@
// @create-index
@@ -0,0 +1 @@
// @create-index
@@ -0,0 +1 @@
// @create-index
+1
View File
@@ -0,0 +1 @@
// @create-index
@@ -0,0 +1 @@
// @create-index
+1
View File
@@ -0,0 +1 @@
// @create-index
+1
View File
@@ -0,0 +1 @@
// @create-index
+73
View File
@@ -0,0 +1,73 @@
import path from 'path';
import {
expect
} from 'chai';
import readDirectory from '../src/utilities/readDirectory';
const fixturesPath = path.resolve(__dirname, 'fixtures/read-directory');
describe('readDirectory()', () => {
context('target directory contains child directories', () => {
it('gets names of the children directories', () => {
const names = readDirectory(path.resolve(fixturesPath, 'children-directories'));
expect(names).to.deep.equal(['bar', 'foo']);
});
});
context('target directory contains child directories that do not contain index', () => {
it('gets names of the children directories', () => {
const names = readDirectory(path.resolve(fixturesPath, 'children-directories-without-index'));
expect(names).to.deep.equal(['present.js']);
});
});
context('target directory contains child directories (unsafe name)', () => {
it('gets names of the children directories', () => {
const names = readDirectory(path.resolve(fixturesPath, 'children-directories-unsafe-name'));
expect(names).to.deep.equal(['present']);
});
});
context('target directory contains ./index.js', () => {
it('does not include ./index.js', () => {
const names = readDirectory(path.resolve(fixturesPath, 'children-index'));
expect(names).to.deep.equal(['bar', 'foo']);
});
});
context('target directory contains files', () => {
it('refers to the files (with extension)', () => {
const names = readDirectory(path.resolve(fixturesPath, 'children-files'));
expect(names).to.deep.equal(['bar.js', 'foo.js']);
});
});
context('target directory contains dot files', () => {
it('ignores files', () => {
const names = readDirectory(path.resolve(fixturesPath, 'children-dot-files'));
expect(names).to.deep.equal(['present.js']);
});
});
context('target directory contains files with no extension', () => {
it('ignores files', () => {
const names = readDirectory(path.resolve(fixturesPath, 'children-files-no-extension'));
expect(names).to.deep.equal(['present.js']);
});
});
context('target directory contains files with multiple extensions', () => {
it('ignores files', () => {
const names = readDirectory(path.resolve(fixturesPath, 'children-files-multiple-extensions'));
expect(names).to.deep.equal(['present.js']);
});
});
context('target directory contains directories and files with the same name', () => {
it('prefers file', () => {
const names = readDirectory(path.resolve(fixturesPath, 'children-directories-and-files'));
expect(names).to.deep.equal(['foo.js', 'present.js']);
});
});
});
+19
View File
@@ -0,0 +1,19 @@
import {
expect
} from 'chai';
import sortByDepth from './../src/utilities/sortByDepth';
describe('sortByDepth()', () => {
it('sorts from deepest to the most shallow', () => {
const paths = [
'/b',
'/a',
'/a/b/c',
'/a/b'
];
const sortedPaths = sortByDepth(paths);
expect(sortedPaths).to.deep.equal(['/a/b/c', '/a/b', '/b', '/a']);
});
});
+47
View File
@@ -0,0 +1,47 @@
/* eslint-disable max-nested-callbacks */
import path from 'path';
import {
expect
} from 'chai';
import validateTargetDirectory from '../src/utilities/validateTargetDirectory';
const fixturesPath = path.resolve(__dirname, 'fixtures/validate-target-directory');
describe('validateTargetDirectory()', () => {
describe('directory path', () => {
context('refers to a directory that does not exist', () => {
it('throws an error', () => {
expect(() => {
validateTargetDirectory(path.resolve(fixturesPath, 'does-not-exist'));
}).to.throw(Error, 'Directory "' + path.resolve(fixturesPath, 'does-not-exist') + '" does not exist.');
});
});
context('refers to a file', () => {
it('throws an error', () => {
expect(() => {
validateTargetDirectory(path.resolve(fixturesPath, 'not-a-directory.js'));
}).to.throw(Error, '"' + path.resolve(fixturesPath, 'not-a-directory.js') + '" is not a directory.');
});
});
});
describe('target index', () => {
context('no index', () => {
it('returns true', () => {
expect(validateTargetDirectory(path.resolve(fixturesPath, 'no-index'))).to.equal(true);
});
});
context('safe', () => {
it('returns true', () => {
expect(validateTargetDirectory(path.resolve(fixturesPath, 'safe-index'))).to.equal(true);
});
});
context('unsafe', () => {
it('throws an error', () => {
expect(() => {
validateTargetDirectory(path.resolve(fixturesPath, 'unsafe-index'));
}).to.throw(Error, '"' + path.resolve(fixturesPath, 'unsafe-index/index.js') + '" unsafe index.');
});
});
});
});
+36
View File
@@ -0,0 +1,36 @@
/* eslint-disable no-restricted-syntax */
import fs from 'fs';
import path from 'path';
import {
expect
} from 'chai';
import writeIndex from '../src/utilities/writeIndex';
import codeExample from './codeExample';
const fixturesPath = path.resolve(__dirname, 'fixtures/write-index');
describe('writeIndex()', () => {
it('creates index in target directory', () => {
const indexFilePath = path.resolve(fixturesPath, 'mixed/index.js');
try {
fs.unlinkSync(indexFilePath);
// eslint-disable-next-line no-empty
} catch (error) {
}
writeIndex([path.resolve(fixturesPath, 'mixed')]);
const indexCode = fs.readFileSync(indexFilePath, 'utf8');
expect(indexCode).to.equal(codeExample(`
'create index';
export bar from './bar';
export foo from './foo.js';
`));
});
});
-71
View File
@@ -1,71 +0,0 @@
/* eslint-disable no-restricted-syntax */
import {
expect
} from 'chai';
import createIndexCode from './../src/utilities/createIndexCode';
import codeExample from './codeExample';
describe('createIndexCode()', () => {
it('describes no children', () => {
let indexCode;
indexCode = createIndexCode([]);
expect(indexCode).to.equal(codeExample(`
'create index';
`));
});
it('describes a single child', () => {
let indexCode;
indexCode = createIndexCode(['foo']);
expect(indexCode).to.equal(codeExample(`
'create index';
export foo from './foo';
`));
});
it('describes multiple children', () => {
let indexCode;
indexCode = createIndexCode(['bar', 'foo']);
expect(indexCode).to.equal(codeExample(`
'create index';
export bar from './bar';
export foo from './foo';
`));
});
context('file with extension', () => {
it('removes the extension from the export statement', () => {
let indexCode;
indexCode = createIndexCode(['foo.js']);
expect(indexCode).to.equal(codeExample(`
'create index';
export foo from './foo.js';
`));
});
});
context('multiple, unsorted', () => {
it('sorts the files', () => {
let indexCode;
indexCode = createIndexCode(['foo', 'bar']);
expect(indexCode).to.equal(codeExample(`
'create index';
export bar from './bar';
export foo from './foo';
`));
});
});
});
-20
View File
@@ -1,20 +0,0 @@
import {
expect
} from 'chai';
import path from 'path';
import glob from 'glob';
import findIndexFiles from './../src/utilities/findIndexFiles';
const fixturesPath = path.resolve(__dirname, './../../fixtures/find-index-files');
describe('findIndexFiles()', () => {
it('finds only the directories that have an existing valid index file', () => {
let names;
names = findIndexFiles(path.resolve(fixturesPath));
names = names.sort();
expect(names).to.deep.equal(glob.sync(path.resolve(fixturesPath, './**/find-*')));
});
});
-92
View File
@@ -1,92 +0,0 @@
import {
expect
} from 'chai';
import path from 'path';
import readDirectory from './../src/utilities/readDirectory';
const fixturesPath = path.resolve(__dirname, './../../fixtures/read-directory');
describe('readDirectory()', () => {
context('target directory contains child directories', () => {
it('gets names of the children directories', () => {
let names;
names = readDirectory(path.resolve(fixturesPath, 'children-directories'));
expect(names).to.deep.equal(['bar', 'foo']);
});
});
context('target directory contains child directories that do not contain index', () => {
it('gets names of the children directories', () => {
let names;
names = readDirectory(path.resolve(fixturesPath, 'children-directories-without-index'));
expect(names).to.deep.equal(['present.js']);
});
});
context('target directory contains child directories (unsafe name)', () => {
it('gets names of the children directories', () => {
let names;
names = readDirectory(path.resolve(fixturesPath, 'children-directories-unsafe-name'));
expect(names).to.deep.equal(['present']);
});
});
context('target directory contains ./index.js', () => {
it('does not include ./index.js', () => {
let names;
names = readDirectory(path.resolve(fixturesPath, 'children-index'));
expect(names).to.deep.equal(['bar', 'foo']);
});
});
context('target directory contains files', () => {
it('refers to the files (with extension)', () => {
let names;
names = readDirectory(path.resolve(fixturesPath, 'children-files'));
expect(names).to.deep.equal(['bar.js', 'foo.js']);
});
});
context('target directory contains dot files', () => {
it('ignores files', () => {
let names;
names = readDirectory(path.resolve(fixturesPath, 'children-dot-files'));
expect(names).to.deep.equal(['present.js']);
});
});
context('target directory contains files with no extension', () => {
it('ignores files', () => {
let names;
names = readDirectory(path.resolve(fixturesPath, 'children-files-no-extension'));
expect(names).to.deep.equal(['present.js']);
});
});
context('target directory contains files with multiple extensions', () => {
it('ignores files', () => {
let names;
names = readDirectory(path.resolve(fixturesPath, 'children-files-multiple-extensions'));
expect(names).to.deep.equal(['present.js']);
});
});
context('target directory contains directories and files with the same name', () => {
it('prefers file', () => {
let names;
names = readDirectory(path.resolve(fixturesPath, 'children-directories-and-files'));
expect(names).to.deep.equal(['foo.js', 'present.js']);
});
});
});
-22
View File
@@ -1,22 +0,0 @@
import {
expect
} from 'chai';
import sortByDepth from './../src/utilities/sortByDepth';
describe('sortByDepth()', () => {
it('sorts from deepest to the most shallow', () => {
let paths,
sortedPaths;
paths = [
'/b',
'/a',
'/a/b/c',
'/a/b'
];
sortedPaths = sortByDepth(paths);
expect(sortedPaths).to.deep.equal(['/a/b/c', '/a/b', '/b', '/a']);
});
});
-47
View File
@@ -1,47 +0,0 @@
/* eslint-disable max-nested-callbacks */
import {
expect
} from 'chai';
import path from 'path';
import validateTargetDirectory from './../src/utilities/validateTargetDirectory';
const fixturesPath = path.resolve(__dirname, './../../fixtures/validate-target-directory');
describe('validateTargetDirectory()', () => {
describe('directory path', () => {
context('refers to a directory that does not exist', () => {
it('throws an error', () => {
expect(() => {
validateTargetDirectory(path.resolve(fixturesPath, 'does-not-exist'));
}).to.throw(Error, 'Directory "' + path.resolve(fixturesPath, 'does-not-exist') + '" does not exist.');
});
});
context('refers to a file', () => {
it('throws an error', () => {
expect(() => {
validateTargetDirectory(path.resolve(fixturesPath, 'not-a-directory.js'));
}).to.throw(Error, '"' + path.resolve(fixturesPath, 'not-a-directory.js') + '" is not a directory.');
});
});
});
describe('target index', () => {
context('no index', () => {
it('returns true', () => {
expect(validateTargetDirectory(path.resolve(fixturesPath, 'no-index'))).to.equal(true);
});
});
context('safe', () => {
it('returns true', () => {
expect(validateTargetDirectory(path.resolve(fixturesPath, 'safe-index'))).to.equal(true);
});
});
context('unsafe', () => {
it('throws an error', () => {
expect(() => {
validateTargetDirectory(path.resolve(fixturesPath, 'unsafe-index'));
}).to.throw(Error, '"' + path.resolve(fixturesPath, 'unsafe-index/index.js') + '" unsafe index.');
});
});
});
});
-39
View File
@@ -1,39 +0,0 @@
/* eslint-disable no-restricted-syntax */
import {
expect
} from 'chai';
import fs from 'fs';
import path from 'path';
import codeExample from './codeExample';
import writeIndex from './../src/utilities/writeIndex';
const fixturesPath = path.resolve(__dirname, './../../fixtures/write-index');
describe('writeIndex()', () => {
it('creates index in target directory', () => {
let indexCode,
indexFilePath;
indexFilePath = path.resolve(fixturesPath, './mixed/index.js');
try {
fs.unlinkSync(indexFilePath);
/* eslint-disable no-empty */
} catch (error) {
}
/* eslint-enable no-empty */
writeIndex([path.resolve(fixturesPath, './mixed')]);
indexCode = fs.readFileSync(indexFilePath, 'utf8');
expect(indexCode).to.equal(codeExample(`
'create index';
export bar from './bar';
export foo from './foo.js';
`));
});
});