eslint-plugin-css-modules
Version:
Checks that you are using the existent css/scss/less classes, no more no less
141 lines (113 loc) • 13.2 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
var _fp = require('lodash/fp');
var _fp2 = _interopRequireDefault(_fp);
var _lodash = require('lodash');
var _lodash2 = _interopRequireDefault(_lodash);
var _core = require('../core');
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
exports.default = {
meta: {
docs: {
description: 'Checks that you are using all css/scss/less classes',
recommended: true
},
schema: [{
type: 'object',
properties: {
camelCase: { enum: [true, 'dashes', 'only', 'dashes-only'] },
markAsUsed: { type: 'array' }
}
}]
},
create: function create(context) {
var markAsUsed = _lodash2.default.get(context, 'options[0].markAsUsed');
var camelCase = _lodash2.default.get(context, 'options[0].camelCase');
/*
maps variable name to property Object
map = {
[variableName]: {
classes: { foo: false, 'foo-bar': false },
classesMap: { foo: 'foo', fooBar: 'foo-bar', 'foo-bar': 'foo-bar' },
node: {...}
}
}
example:
import s from './foo.scss';
s is variable name
property Object has two keys
1. classes: an object with className as key and a boolean as value. The boolean is marked if it is used in file
2. classesMap: an object with propertyName as key and its className as value
3. node: node that correspond to s (see example above)
*/
var map = {};
return {
ImportDeclaration: function ImportDeclaration(node) {
var styleImportNodeData = (0, _core.getStyleImportNodeData)(node);
if (!styleImportNodeData) {
return;
}
var importName = styleImportNodeData.importName,
styleFilePath = styleImportNodeData.styleFilePath,
importNode = styleImportNodeData.importNode;
var styleFileAbsolutePath = (0, _core.getFilePath)(context, styleFilePath);
// this will be used to mark s.foo as used in MemberExpression
var classes = (0, _core.getStyleClasses)(styleFileAbsolutePath);
var classesMap = classes && (0, _core.getClassesMap)(classes, camelCase);
_lodash2.default.set(map, importName + '.classes', classes);
_lodash2.default.set(map, importName + '.classesMap', classesMap);
// save node for reporting unused styles
_lodash2.default.set(map, importName + '.node', importNode);
},
MemberExpression: function MemberExpression(node) {
/*
Check if property exists in css/scss file as class
*/
var objectName = node.object.name;
var propertyName = (0, _core.getPropertyName)(node, camelCase);
if (!propertyName) {
return;
}
var className = _lodash2.default.get(map, objectName + '.classesMap.' + propertyName);
if (className == null) {
return;
}
// mark this property has used
_lodash2.default.set(map, objectName + '.classes.' + className, true);
},
'Program:exit': function ProgramExit() {
/*
Check if all classes defined in css/scss file are used
*/
/*
we are looping over each import style node in program
example:
```
import s from './foo.css';
import x from './bar.scss';
```
then the loop will be run 2 times
*/
_lodash2.default.forIn(map, function (o) {
var classes = o.classes,
node = o.node;
/*
if option is passed to mark a class as used, example:
eslint css-modules/no-unused-class: [2, { markAsUsed: ['container'] }]
*/
_lodash2.default.forEach(markAsUsed, function (usedClass) {
classes[usedClass] = true;
});
// classNames not marked as true are unused
var unusedClasses = _fp2.default.compose(_fp2.default.keys, _fp2.default.omitBy(_fp2.default.identity))(classes);
if (!_lodash2.default.isEmpty(unusedClasses)) {
context.report(node, 'Unused classes found: ' + unusedClasses.join(', '));
}
});
}
};
}
};
//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"sources":["../../lib/rules/no-unused-class.js"],"names":["meta","docs","description","recommended","schema","type","properties","camelCase","enum","markAsUsed","create","context","get","map","ImportDeclaration","node","styleImportNodeData","importName","styleFilePath","importNode","styleFileAbsolutePath","classes","classesMap","set","MemberExpression","objectName","object","name","propertyName","className","forIn","o","forEach","usedClass","unusedClasses","compose","keys","omitBy","identity","isEmpty","report","join"],"mappings":";;;;;;AACA;;;;AACA;;;;AAEA;;;;kBAUe;AACbA,QAAM;AACJC,UAAM;AACJC,mBAAa,qDADT;AAEJC,mBAAa;AAFT,KADF;AAKJC,YAAQ,CACN;AACEC,YAAM,QADR;AAEEC,kBAAY;AACVC,mBAAW,EAAEC,MAAM,CAAC,IAAD,EAAO,QAAP,EAAiB,MAAjB,EAAyB,aAAzB,CAAR,EADD;AAEVC,oBAAY,EAAEJ,MAAM,OAAR;AAFF;AAFd,KADM;AALJ,GADO;AAgBbK,QAhBa,kBAgBLC,OAhBK,EAgBY;AACvB,QAAMF,aAAa,iBAAEG,GAAF,CAAMD,OAAN,EAAe,uBAAf,CAAnB;AACA,QAAMJ,YAAY,iBAAEK,GAAF,CAAMD,OAAN,EAAe,sBAAf,CAAlB;;AAEA;;;;;;;;;;;;;;;;;AAmBA,QAAME,MAAM,EAAZ;;AAEA,WAAO;AACLC,uBADK,6BACcC,IADd,EAC4B;AAC/B,YAAMC,sBAAsB,kCAAuBD,IAAvB,CAA5B;;AAEA,YAAI,CAACC,mBAAL,EAA0B;AACxB;AACD;;AAL8B,YAQ7BC,UAR6B,GAW3BD,mBAX2B,CAQ7BC,UAR6B;AAAA,YAS7BC,aAT6B,GAW3BF,mBAX2B,CAS7BE,aAT6B;AAAA,YAU7BC,UAV6B,GAW3BH,mBAX2B,CAU7BG,UAV6B;;;AAa/B,YAAMC,wBAAwB,uBAAYT,OAAZ,EAAqBO,aAArB,CAA9B;;AAEA;AACA,YAAMG,UAAU,2BAAgBD,qBAAhB,CAAhB;AACA,YAAME,aAAaD,WAAW,yBAAcA,OAAd,EAAuBd,SAAvB,CAA9B;;AAEA,yBAAEgB,GAAF,CAAMV,GAAN,EAAcI,UAAd,eAAoCI,OAApC;AACA,yBAAEE,GAAF,CAAMV,GAAN,EAAcI,UAAd,kBAAuCK,UAAvC;;AAEA;AACA,yBAAEC,GAAF,CAAMV,GAAN,EAAcI,UAAd,YAAiCE,UAAjC;AACD,OAzBI;;AA0BLK,wBAAkB,0BAACT,IAAD,EAAkB;AAClC;;;;AAIA,YAAMU,aAAaV,KAAKW,MAAL,CAAYC,IAA/B;AACA,YAAMC,eAAe,2BAAgBb,IAAhB,EAAsBR,SAAtB,CAArB;;AAEA,YAAI,CAACqB,YAAL,EAAmB;AACjB;AACD;;AAED,YAAMC,YAAY,iBAAEjB,GAAF,CAAMC,GAAN,EAAcY,UAAd,oBAAuCG,YAAvC,CAAlB;;AAEA,YAAIC,aAAa,IAAjB,EAAuB;AACrB;AACD;;AAED;AACA,yBAAEN,GAAF,CAAMV,GAAN,EAAcY,UAAd,iBAAoCI,SAApC,EAAiD,IAAjD;AACD,OA9CI;AA+CL,oBA/CK,yBA+Ca;AAChB;;;;AAIA;;;;;;;;;AASA,yBAAEC,KAAF,CAAQjB,GAAR,EAAa,UAACkB,CAAD,EAAO;AAAA,cACVV,OADU,GACQU,CADR,CACVV,OADU;AAAA,cACDN,IADC,GACQgB,CADR,CACDhB,IADC;;AAGlB;;;;;AAIA,2BAAEiB,OAAF,CAAUvB,UAAV,EAAsB,UAACwB,SAAD,EAAe;AACnCZ,oBAAQY,SAAR,IAAqB,IAArB;AACD,WAFD;;AAIA;AACA,cAAMC,gBAAgB,aAAGC,OAAH,CACpB,aAAGC,IADiB,EAEpB,aAAGC,MAAH,CAAU,aAAGC,QAAb,CAFoB,EAGpBjB,OAHoB,CAAtB;;AAKA,cAAI,CAAC,iBAAEkB,OAAF,CAAUL,aAAV,CAAL,EAA+B;AAC7BvB,oBAAQ6B,MAAR,CAAezB,IAAf,6BAA8CmB,cAAcO,IAAd,CAAmB,IAAnB,CAA9C;AACD;AACF,SApBD;AAqBD;AAlFI,KAAP;AAoFD;AA7HY,C","file":"no-unused-class.js","sourcesContent":["/* @flow */\nimport fp from 'lodash/fp';\nimport _ from 'lodash';\n\nimport {\n  getStyleImportNodeData,\n  getStyleClasses,\n  getPropertyName,\n  getClassesMap,\n  getFilePath,\n} from '../core';\n\nimport type { JsNode } from '../types';\n\nexport default {\n  meta: {\n    docs: {\n      description: 'Checks that you are using all css/scss/less classes',\n      recommended: true,\n    },\n    schema: [\n      {\n        type: 'object',\n        properties: {\n          camelCase: { enum: [true, 'dashes', 'only', 'dashes-only'] },\n          markAsUsed: { type: 'array' },\n        },\n      }\n    ],\n  },\n  create (context: Object) {\n    const markAsUsed = _.get(context, 'options[0].markAsUsed');\n    const camelCase = _.get(context, 'options[0].camelCase');\n\n    /*\n       maps variable name to property Object\n       map = {\n         [variableName]: {\n           classes: { foo: false, 'foo-bar': false },\n           classesMap: { foo: 'foo', fooBar: 'foo-bar', 'foo-bar': 'foo-bar' },\n           node: {...}\n         }\n       }\n\n       example:\n       import s from './foo.scss';\n       s is variable name\n\n       property Object has two keys\n       1. classes: an object with className as key and a boolean as value. The boolean is marked if it is used in file\n       2. classesMap: an object with propertyName as key and its className as value\n       3. node: node that correspond to s (see example above)\n     */\n    const map = {};\n\n    return {\n      ImportDeclaration (node: JsNode) {\n        const styleImportNodeData = getStyleImportNodeData(node);\n\n        if (!styleImportNodeData) {\n          return;\n        }\n\n        const {\n          importName,\n          styleFilePath,\n          importNode,\n        } = styleImportNodeData;\n\n        const styleFileAbsolutePath = getFilePath(context, styleFilePath);\n\n        // this will be used to mark s.foo as used in MemberExpression\n        const classes = getStyleClasses(styleFileAbsolutePath);\n        const classesMap = classes && getClassesMap(classes, camelCase);\n\n        _.set(map, `${importName}.classes`, classes);\n        _.set(map, `${importName}.classesMap`, classesMap);\n\n        // save node for reporting unused styles\n        _.set(map, `${importName}.node`, importNode);\n      },\n      MemberExpression: (node: JsNode) => {\n        /*\n           Check if property exists in css/scss file as class\n         */\n\n        const objectName = node.object.name;\n        const propertyName = getPropertyName(node, camelCase);\n\n        if (!propertyName) {\n          return;\n        }\n\n        const className = _.get(map, `${objectName}.classesMap.${propertyName}`);\n\n        if (className == null) {\n          return;\n        }\n\n        // mark this property has used\n        _.set(map, `${objectName}.classes.${className}`, true);\n      },\n      'Program:exit' () {\n        /*\n           Check if all classes defined in css/scss file are used\n         */\n\n        /*\n           we are looping over each import style node in program\n           example:\n           ```\n             import s from './foo.css';\n             import x from './bar.scss';\n           ```\n           then the loop will be run 2 times\n         */\n        _.forIn(map, (o) => {\n          const { classes, node } = o;\n\n          /*\n             if option is passed to mark a class as used, example:\n             eslint css-modules/no-unused-class: [2, { markAsUsed: ['container'] }]\n           */\n          _.forEach(markAsUsed, (usedClass) => {\n            classes[usedClass] = true;\n          });\n\n          // classNames not marked as true are unused\n          const unusedClasses = fp.compose(\n            fp.keys,\n            fp.omitBy(fp.identity), // omit truthy values\n          )(classes);\n\n          if (!_.isEmpty(unusedClasses)) {\n            context.report(node, `Unused classes found: ${unusedClasses.join(', ')}`);\n          }\n        });\n      }\n    };\n  }\n};\n"]}