Skip to content

Commit 1e817d1

Browse files
author
Michael Ledin
committed
Move Cmify.prototype_flush to cmify module. Move plugin loading to separate function. Use cache option instead of global cache.
1 parent cda3b4b commit 1e817d1

File tree

4 files changed

+105
-82
lines changed

4 files changed

+105
-82
lines changed

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ b.on('css stream', function (css) {
7272
- `generateScopedName`: (API only) a function to override the default behaviour of creating locally scoped classnames.
7373
- `global`: optional boolean. Set to `true` if you want `css-modulesify` to apply to `node_modules` as well as local files. You can read more about it in the [browserify docs](https://github.com/substack/node-browserify/#btransformtr-opts).
7474
- `filePattern`: optional regular expression string to specify css file names. (default: `\.css$`)
75+
- `cache`: optional object to persist cache between runs.
7576

7677
### Events
7778
- `b.on('css stream', callback)` The callback is called with a readable stream containing the compiled CSS. You can write this to a file.

‎cmify.js‎

Lines changed: 56 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
var stream = require("stream");
2-
var path = require("path");
3-
var util = require("util");
1+
var stream = require('stream');
2+
var util = require('util');
3+
var assign = require('object-assign');
4+
var path = require('path');
45

56
util.inherits(Cmify, stream.Transform);
67
function Cmify (filename, opts) {
@@ -14,6 +15,10 @@ function Cmify (filename, opts) {
1415
this._data = '';
1516
this._filename = filename;
1617
this._cssOutFilename = opts.cssOutFilename;
18+
this._loader = opts.loader;
19+
this._tokensByFile = opts.tokensByFile;
20+
this._rootDir = opts.rootDir;
21+
opts.cssFiles.push(filename);
1722
}
1823

1924
Cmify.prototype.isCssFile = function (filename) {
@@ -31,4 +36,52 @@ Cmify.prototype._transform = function (buf, enc, callback) {
3136
callback();
3237
};
3338

39+
Cmify.prototype._flush = function (callback) {
40+
var self = this;
41+
var filename = this._filename;
42+
43+
// only handle .css files
44+
if (!this.isCssFile(filename)) { return callback(); }
45+
46+
// grab the correct loader
47+
var loader = this._loader;
48+
var tokensByFile = this._tokensByFile;
49+
50+
// convert css to js before pushing
51+
// reset the `tokensByFile` state
52+
var relFilename = path.relative(this._rootDir, filename);
53+
tokensByFile[filename] = loader.tokensByFile[filename] = null;
54+
55+
loader.fetch(relFilename, '/').then(function (tokens) {
56+
var deps = loader.deps.dependenciesOf(filename);
57+
var output = deps.map(function (f) {
58+
return 'require("' + f + '")';
59+
});
60+
output.push('module.exports = ' + JSON.stringify(tokens));
61+
62+
var isValid = true;
63+
var isUndefined = /\bundefined\b/;
64+
Object.keys(tokens).forEach(function (k) {
65+
if (isUndefined.test(tokens[k])) {
66+
isValid = false;
67+
}
68+
});
69+
70+
if (!isValid) {
71+
var err = 'Composition in ' + filename + ' contains an undefined reference';
72+
console.error(err);
73+
output.push('console.error("' + err + '");');
74+
}
75+
76+
assign(tokensByFile, loader.tokensByFile);
77+
78+
self.push(output.join('\n'));
79+
return callback();
80+
}).catch(function (err) {
81+
self.push('console.error("' + err + '");');
82+
self.emit('error', err);
83+
return callback();
84+
});
85+
};
86+
3487
module.exports = Cmify;

‎index.js‎

Lines changed: 46 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ var path = require('path');
66
var Cmify = require('./cmify');
77
var Core = require('css-modules-loader-core');
88
var FileSystemLoader = require('./file-system-loader');
9-
var assign = require('object-assign');
109
var stringHash = require('string-hash');
1110
var ReadableStream = require('stream').Readable;
1211
var through = require('through2');
@@ -75,35 +74,8 @@ function normalizeManifestPaths (tokensByFile, rootDir) {
7574
return output;
7675
}
7776

78-
// caches
79-
//
80-
// persist these for as long as the process is running. #32
81-
82-
// keep track of all tokens so we can avoid duplicates
83-
var tokensByFile = {};
84-
85-
// we need a separate loader for each entry point
86-
var loadersByFile = {};
87-
88-
module.exports = function (browserify, options) {
89-
options = options || {};
90-
91-
// if no root directory is specified, assume the cwd
92-
var rootDir = options.rootDir || options.d || browserify._options.basedir;
93-
if (rootDir) { rootDir = path.resolve(rootDir); }
94-
if (!rootDir) { rootDir = process.cwd(); }
95-
96-
var transformOpts = {};
97-
if (options.global || options.g) {
98-
transformOpts.global = true;
99-
}
100-
101-
var cssOutFilename = options.output || options.o;
102-
var jsonOutFilename = options.json || options.jsonOutput;
103-
transformOpts.cssOutFilename = cssOutFilename;
104-
transformOpts.cssFilePattern = options.filePattern;
105-
106-
// PostCSS plugins passed to FileSystemLoader
77+
// PostCSS plugins passed to FileSystemLoader
78+
function getPlugins (options) {
10779
var plugins = options.use || options.u;
10880
if (!plugins) {
10981
plugins = getDefaultPlugins(options);
@@ -119,7 +91,7 @@ module.exports = function (browserify, options) {
11991
plugins = (Array.isArray(postcssBefore) ? postcssBefore : [postcssBefore]).concat(plugins).concat(postcssAfter);
12092

12193
// load plugins by name (if a string is used)
122-
plugins = plugins.map(function requirePlugin (name) {
94+
return plugins.map(function requirePlugin (name) {
12395
// assume not strings are already required plugins
12496
if (typeof name !== 'string') {
12597
return name;
@@ -144,58 +116,54 @@ module.exports = function (browserify, options) {
144116

145117
return plugin;
146118
});
119+
}
147120

148-
// create a loader for this entry file
149-
if (!loadersByFile[cssOutFilename]) {
150-
loadersByFile[cssOutFilename] = new FileSystemLoader(rootDir, plugins);
121+
module.exports = function (browserify, options) {
122+
options = options || {};
123+
124+
// if no root directory is specified, assume the cwd
125+
var rootDir = options.rootDir || options.d || browserify._options.basedir;
126+
if (rootDir) {
127+
rootDir = path.resolve(rootDir);
128+
}
129+
if (!rootDir) {
130+
rootDir = process.cwd();
151131
}
152132

153-
// TODO: clean this up so there's less scope crossing
154-
Cmify.prototype._flush = function (callback) {
155-
var self = this;
156-
var filename = this._filename;
157-
158-
// only handle .css files
159-
if (!this.isCssFile(filename)) { return callback(); }
160-
161-
// grab the correct loader
162-
var loader = loadersByFile[this._cssOutFilename];
163-
164-
// convert css to js before pushing
165-
// reset the `tokensByFile` cache
166-
var relFilename = path.relative(rootDir, filename);
167-
tokensByFile[filename] = loader.tokensByFile[filename] = null;
168-
169-
loader.fetch(relFilename, '/').then(function (tokens) {
170-
var deps = loader.deps.dependenciesOf(filename);
171-
var output = deps.map(function (f) {
172-
return 'require("' + f + '")';
173-
});
174-
output.push('module.exports = ' + JSON.stringify(tokens));
175-
176-
var isValid = true;
177-
var isUndefined = /\bundefined\b/;
178-
Object.keys(tokens).forEach(function (k) {
179-
if (isUndefined.test(tokens[k])) {
180-
isValid = false;
181-
}
182-
});
183-
184-
if (!isValid) {
185-
var err = 'Composition in ' + filename + ' contains an undefined reference';
186-
console.error(err);
187-
output.push('console.error("' + err + '");');
188-
}
133+
var cssOutFilename = options.output || options.o;
134+
var jsonOutFilename = options.json || options.jsonOutput;
135+
var loader;
136+
// keep track of all tokens so we can avoid duplicates
137+
var tokensByFile;
138+
if (options.cache) {
139+
if (options.cache.loaders) {
140+
loader = options.cache.loaders[cssOutFilename];
141+
} else {
142+
options.cache.loaders = {};
143+
}
144+
if (options.cache.tokens) {
145+
tokensByFile = options.cache.tokens;
146+
} else {
147+
options.cache.tokens = {};
148+
}
149+
}
189150

190-
assign(tokensByFile, loader.tokensByFile);
151+
loader = loader || new FileSystemLoader(rootDir, getPlugins(options));
152+
tokensByFile = tokensByFile || {};
191153

192-
self.push(output.join('\n'));
193-
return callback();
194-
}).catch(function (err) {
195-
self.push('console.error("' + err + '");');
196-
self.emit('error', err);
197-
return callback();
198-
});
154+
if (options.cache) {
155+
options.cache.loaders[cssOutFilename] = loader;
156+
options.cache.tokens = tokensByFile;
157+
}
158+
159+
var transformOpts = {
160+
cssFilePattern: options.filePattern
161+
, cssFiles: []
162+
, cssOutFilename: cssOutFilename
163+
, global: options.global || options.g
164+
, loader: loader
165+
, rootDir: rootDir
166+
, tokensByFile: tokensByFile
199167
};
200168

201169
browserify.transform(Cmify, transformOpts);
@@ -214,7 +182,6 @@ module.exports = function (browserify, options) {
214182

215183
// Combine the collected sources for a single bundle into a single CSS file
216184
var self = this;
217-
var loader = loadersByFile[cssOutFilename];
218185
var css = loader.finalSource;
219186

220187
// end the output stream

‎tests/cache.js‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ tape('multiple builds', function (t) {
2525
fs: fakeFs
2626
});
2727

28+
var cssModulesifyCache = {};
2829
var getBundler = rebundler(function (cache, packageCache) {
2930
return browserify(path.join(simpleCaseDir, 'main.js'), {
3031
cache: cache
@@ -34,6 +35,7 @@ tape('multiple builds', function (t) {
3435
.plugin(cssModulesify, {
3536
rootDir: path.join(simpleCaseDir)
3637
, output: cssOutFilename
38+
, cache: cssModulesifyCache
3739
});
3840
});
3941

0 commit comments

Comments
 (0)