feat: use comment to target files (fixes #5)

This commit is contained in:
Gajus Kuizinas
2016-11-01 15:58:31 +00:00
parent c41edde1cd
commit 91c2e4eae3
23 changed files with 26 additions and 26 deletions
+4 -4
View File
@@ -34,7 +34,7 @@
This created `index.js` with: This created `index.js` with:
```js ```js
'create index'; // @create-index
export bar from './bar.js'; export bar from './bar.js';
export foo from './foo.js'; export foo from './foo.js';
@@ -64,7 +64,7 @@ Lets create a new file and re-run `create-index`:
This have updated `index.js` file: This have updated `index.js` file:
```js ```js
'create index'; // @create-index
export bar from './bar.js'; export bar from './bar.js';
export baz from './baz.js'; export baz from './baz.js';
@@ -152,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 -1
View File
@@ -25,7 +25,7 @@ export default (targetDirectory) => {
const 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.');
} }
@@ -1 +1 @@
'create index'; // @create-index
+1 -1
View File
@@ -1 +1 @@
// 'create index'; // create-index
+1 -1
View File
@@ -1 +1 @@
'create index'; // @create-index
+1 -1
View File
@@ -1 +1 @@
// 'create index'; // create-index
+1 -1
View File
@@ -1 +1 @@
'create index'; // @create-index
+1 -1
View File
@@ -1 +1 @@
'create index'; // @create-index
@@ -1 +1 @@
'create index'; // @create-index
@@ -1 +1 @@
'create index'; // @create-index
@@ -1 +1 @@
'create index'; // @create-index
@@ -1 +1 @@
'create index'; // @create-index
@@ -1 +1 @@
'create index'; // @create-index
@@ -1 +1 @@
'create index'; // @create-index
@@ -1 +1 @@
'create index'; // @create-index
@@ -1 +1 @@
'create index'; // @create-index
@@ -1 +1 @@
'create index'; // @create-index
+1 -1
View File
@@ -1 +1 @@
'create index'; // @create-index
+1 -1
View File
@@ -1 +1 @@
'create index'; // @create-index
+1 -1
View File
@@ -1 +1 @@
'create index'; // @create-index
@@ -1 +1 @@
'create index'; // @create-index
+1 -1
View File
@@ -1 +1 @@
'create index'; // @create-index
+1 -1
View File
@@ -1 +1 @@
'create index'; // @create-index