Skip to content

Commit a501485

Browse files
committed
fix docblock
1 parent 1347c4b commit a501485

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

index.js

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -160,21 +160,20 @@ renameCssSelectors.processCss = (pathString, options, cb) => {
160160
* @property {Boolean | String} [cssMapping=true] true will generate the css mapping. A string will generate the css mapping file and the object is called like the string
161161
* @property {Boolean | String} [cssMappingMin=false] like the property cssMapping
162162
* @property {Boolean} [extended=false] defines if metadata should be added to the selector
163-
* @property {Boolean} [json=false] defines if metadata should be added to the selector
163+
* @property {Boolean} [json=true] defines if metadata should be added to the selector
164+
* @property {Boolean} [isSelectors=true] if it should write the selector type into the key (# | .)
164165
*/
165166
/**
166167
* generates a file including all old and new selectors/names
167168
* includes also unused class selectors
168169
*
169-
* @todo generrate a json config file
170-
*
171170
* @param {String} pathString where it should get saved
172171
* @param {generateMappingOptions} [options]
173172
*/
174173
renameCssSelectors.generateMapping = (pathString, options, cb) => {
175-
let mappingName = 'CSS_NAME_MAPPING';
174+
let fileName = 'renaming_map';
176175
let fileNameExt = '.json';
177-
let fileName = 'renaming_map';
176+
let mappingName = 'CSS_NAME_MAPPING';
178177

179178
const optionsDefault = {
180179
cssMapping: true,
@@ -232,6 +231,12 @@ renameCssSelectors.generateMapping = (pathString, options, cb) => {
232231
});
233232
}; // /generateMapping
234233

234+
/**
235+
* load the mapping file
236+
*
237+
* @param {Object | String} pathString could be either the path or the mapping object
238+
* @param {Object} [options]
239+
*/
235240
renameCssSelectors.loadMapping = (pathString, options) => {
236241
let selectors = pathString;
237242

0 commit comments

Comments
 (0)