116 lines
12 KiB
JavaScript
116 lines
12 KiB
JavaScript
'use strict';
|
|
|
|
var _docsUrl = require('../docsUrl');var _docsUrl2 = _interopRequireDefault(_docsUrl);function _interopRequireDefault(obj) {return obj && obj.__esModule ? obj : { 'default': obj };}
|
|
|
|
var SINGLE_EXPORT_ERROR_MESSAGE = 'Prefer default export on a file with single export.';
|
|
var ANY_EXPORT_ERROR_MESSAGE = 'Prefer default export to be present on every file that has export.';
|
|
|
|
module.exports = {
|
|
meta: {
|
|
type: 'suggestion',
|
|
docs: {
|
|
category: 'Style guide',
|
|
description: 'Prefer a default export if module exports a single name or multiple names.',
|
|
url: (0, _docsUrl2['default'])('prefer-default-export') },
|
|
|
|
schema: [{
|
|
type: 'object',
|
|
properties: {
|
|
target: {
|
|
type: 'string',
|
|
'enum': ['single', 'any'],
|
|
'default': 'single' } },
|
|
|
|
|
|
additionalProperties: false }] },
|
|
|
|
|
|
|
|
create: function () {function create(context) {
|
|
var specifierExportCount = 0;
|
|
var hasDefaultExport = false;
|
|
var hasStarExport = false;
|
|
var hasTypeExport = false;
|
|
var namedExportNode = null;
|
|
// get options. by default we look into files with single export
|
|
var _ref = context.options[0] || {},_ref$target = _ref.target,target = _ref$target === undefined ? 'single' : _ref$target;
|
|
function captureDeclaration(identifierOrPattern) {
|
|
if (identifierOrPattern && identifierOrPattern.type === 'ObjectPattern') {
|
|
// recursively capture
|
|
identifierOrPattern.properties.
|
|
forEach(function (property) {
|
|
captureDeclaration(property.value);
|
|
});
|
|
} else if (identifierOrPattern && identifierOrPattern.type === 'ArrayPattern') {
|
|
identifierOrPattern.elements.
|
|
forEach(captureDeclaration);
|
|
} else {
|
|
// assume it's a single standard identifier
|
|
specifierExportCount++;
|
|
}
|
|
}
|
|
|
|
return {
|
|
ExportDefaultSpecifier: function () {function ExportDefaultSpecifier() {
|
|
hasDefaultExport = true;
|
|
}return ExportDefaultSpecifier;}(),
|
|
|
|
ExportSpecifier: function () {function ExportSpecifier(node) {
|
|
if ((node.exported.name || node.exported.value) === 'default') {
|
|
hasDefaultExport = true;
|
|
} else {
|
|
specifierExportCount++;
|
|
namedExportNode = node;
|
|
}
|
|
}return ExportSpecifier;}(),
|
|
|
|
ExportNamedDeclaration: function () {function ExportNamedDeclaration(node) {
|
|
// if there are specifiers, node.declaration should be null
|
|
if (!node.declaration) {return;}var
|
|
|
|
type = node.declaration.type;
|
|
|
|
if (
|
|
type === 'TSTypeAliasDeclaration' ||
|
|
type === 'TypeAlias' ||
|
|
type === 'TSInterfaceDeclaration' ||
|
|
type === 'InterfaceDeclaration')
|
|
{
|
|
specifierExportCount++;
|
|
hasTypeExport = true;
|
|
return;
|
|
}
|
|
|
|
if (node.declaration.declarations) {
|
|
node.declaration.declarations.forEach(function (declaration) {
|
|
captureDeclaration(declaration.id);
|
|
});
|
|
} else {
|
|
// captures 'export function foo() {}' syntax
|
|
specifierExportCount++;
|
|
}
|
|
|
|
namedExportNode = node;
|
|
}return ExportNamedDeclaration;}(),
|
|
|
|
ExportDefaultDeclaration: function () {function ExportDefaultDeclaration() {
|
|
hasDefaultExport = true;
|
|
}return ExportDefaultDeclaration;}(),
|
|
|
|
ExportAllDeclaration: function () {function ExportAllDeclaration() {
|
|
hasStarExport = true;
|
|
}return ExportAllDeclaration;}(),
|
|
|
|
'Program:exit': function () {function ProgramExit() {
|
|
if (hasDefaultExport || hasStarExport || hasTypeExport) {
|
|
return;
|
|
}
|
|
if (target === 'single' && specifierExportCount === 1) {
|
|
context.report(namedExportNode, SINGLE_EXPORT_ERROR_MESSAGE);
|
|
} else if (target === 'any' && specifierExportCount > 0) {
|
|
context.report(namedExportNode, ANY_EXPORT_ERROR_MESSAGE);
|
|
}
|
|
}return ProgramExit;}() };
|
|
|
|
}return create;}() };
|
|
//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"sources":["../../src/rules/prefer-default-export.js"],"names":["SINGLE_EXPORT_ERROR_MESSAGE","ANY_EXPORT_ERROR_MESSAGE","module","exports","meta","type","docs","category","description","url","schema","properties","target","additionalProperties","create","context","specifierExportCount","hasDefaultExport","hasStarExport","hasTypeExport","namedExportNode","options","captureDeclaration","identifierOrPattern","forEach","property","value","elements","ExportDefaultSpecifier","ExportSpecifier","node","exported","name","ExportNamedDeclaration","declaration","declarations","id","ExportDefaultDeclaration","ExportAllDeclaration","report"],"mappings":"AAAA;;AAEA,qC;;AAEA,IAAMA,8BAA8B,qDAApC;AACA,IAAMC,2BAA2B,oEAAjC;;AAEAC,OAAOC,OAAP,GAAiB;AACfC,QAAM;AACJC,UAAM,YADF;AAEJC,UAAM;AACJC,gBAAU,aADN;AAEJC,mBAAa,4EAFT;AAGJC,WAAK,0BAAQ,uBAAR,CAHD,EAFF;;AAOJC,YAAQ,CAAC;AACPL,YAAM,QADC;AAEPM,kBAAY;AACVC,gBAAQ;AACNP,gBAAM,QADA;AAEN,kBAAM,CAAC,QAAD,EAAW,KAAX,CAFA;AAGN,qBAAS,QAHH,EADE,EAFL;;;AASPQ,4BAAsB,KATf,EAAD,CAPJ,EADS;;;;AAqBfC,QArBe,+BAqBRC,OArBQ,EAqBC;AACd,UAAIC,uBAAuB,CAA3B;AACA,UAAIC,mBAAmB,KAAvB;AACA,UAAIC,gBAAgB,KAApB;AACA,UAAIC,gBAAgB,KAApB;AACA,UAAIC,kBAAkB,IAAtB;AACA;AANc,iBAOiBL,QAAQM,OAAR,CAAgB,CAAhB,KAAsB,EAPvC,oBAONT,MAPM,CAONA,MAPM,+BAOG,QAPH;AAQd,eAASU,kBAAT,CAA4BC,mBAA5B,EAAiD;AAC/C,YAAIA,uBAAuBA,oBAAoBlB,IAApB,KAA6B,eAAxD,EAAyE;AACvE;AACAkB,8BAAoBZ,UAApB;AACGa,iBADH,CACW,UAAUC,QAAV,EAAoB;AAC3BH,+BAAmBG,SAASC,KAA5B;AACD,WAHH;AAID,SAND,MAMO,IAAIH,uBAAuBA,oBAAoBlB,IAApB,KAA6B,cAAxD,EAAwE;AAC7EkB,8BAAoBI,QAApB;AACGH,iBADH,CACWF,kBADX;AAED,SAHM,MAGC;AACR;AACEN;AACD;AACF;;AAED,aAAO;AACLY,8BADK,iDACoB;AACvBX,+BAAmB,IAAnB;AACD,WAHI;;AAKLY,uBALK,wCAKWC,IALX,EAKiB;AACpB,gBAAI,CAACA,KAAKC,QAAL,CAAcC,IAAd,IAAsBF,KAAKC,QAAL,CAAcL,KAArC,MAAgD,SAApD,EAA+D;AAC7DT,iCAAmB,IAAnB;AACD,aAFD,MAEO;AACLD;AACAI,gCAAkBU,IAAlB;AACD;AACF,WAZI;;AAcLG,8BAdK,+CAckBH,IAdlB,EAcwB;AAC3B;AACA,gBAAI,CAACA,KAAKI,WAAV,EAAuB,CAAE,OAAS,CAFP;;AAInB7B,gBAJmB,GAIVyB,KAAKI,WAJK,CAInB7B,IAJmB;;AAM3B;AACEA,qBAAS,wBAAT;AACGA,qBAAS,WADZ;AAEGA,qBAAS,wBAFZ;AAGGA,qBAAS,sBAJd;AAKE;AACAW;AACAG,8BAAgB,IAAhB;AACA;AACD;;AAED,gBAAIW,KAAKI,WAAL,CAAiBC,YAArB,EAAmC;AACjCL,mBAAKI,WAAL,CAAiBC,YAAjB,CAA8BX,OAA9B,CAAsC,UAAUU,WAAV,EAAuB;AAC3DZ,mCAAmBY,YAAYE,EAA/B;AACD,eAFD;AAGD,aAJD,MAIO;AACL;AACApB;AACD;;AAEDI,8BAAkBU,IAAlB;AACD,WAzCI;;AA2CLO,gCA3CK,mDA2CsB;AACzBpB,+BAAmB,IAAnB;AACD,WA7CI;;AA+CLqB,4BA/CK,+CA+CkB;AACrBpB,4BAAgB,IAAhB;AACD,WAjDI;;AAmDL,sBAnDK,sCAmDY;AACf,gBAAID,oBAAoBC,aAApB,IAAqCC,aAAzC,EAAwD;AACtD;AACD;AACD,gBAAIP,WAAW,QAAX,IAAuBI,yBAAyB,CAApD,EAAuD;AACrDD,sBAAQwB,MAAR,CAAenB,eAAf,EAAgCpB,2BAAhC;AACD,aAFD,MAEO,IAAIY,WAAW,KAAX,IAAoBI,uBAAuB,CAA/C,EAAkD;AACvDD,sBAAQwB,MAAR,CAAenB,eAAf,EAAgCnB,wBAAhC;AACD;AACF,WA5DI,wBAAP;;AA8DD,KA3Gc,mBAAjB","file":"prefer-default-export.js","sourcesContent":["'use strict';\n\nimport docsUrl from '../docsUrl';\n\nconst SINGLE_EXPORT_ERROR_MESSAGE = 'Prefer default export on a file with single export.';\nconst ANY_EXPORT_ERROR_MESSAGE = 'Prefer default export to be present on every file that has export.';\n\nmodule.exports = {\n  meta: {\n    type: 'suggestion',\n    docs: {\n      category: 'Style guide',\n      description: 'Prefer a default export if module exports a single name or multiple names.',\n      url: docsUrl('prefer-default-export'),\n    },\n    schema: [{\n      type: 'object',\n      properties: {\n        target: {\n          type: 'string',\n          enum: ['single', 'any'],\n          default: 'single',\n        },\n      },\n      additionalProperties: false,\n    }],\n  },\n\n  create(context) {\n    let specifierExportCount = 0;\n    let hasDefaultExport = false;\n    let hasStarExport = false;\n    let hasTypeExport = false;\n    let namedExportNode = null;\n    // get options. by default we look into files with single export\n    const { target = 'single' } =  context.options[0] || {};\n    function captureDeclaration(identifierOrPattern) {\n      if (identifierOrPattern && identifierOrPattern.type === 'ObjectPattern') {\n        // recursively capture\n        identifierOrPattern.properties\n          .forEach(function (property) {\n            captureDeclaration(property.value);\n          });\n      } else if (identifierOrPattern && identifierOrPattern.type === 'ArrayPattern') {\n        identifierOrPattern.elements\n          .forEach(captureDeclaration);\n      } else  {\n      // assume it's a single standard identifier\n        specifierExportCount++;\n      }\n    }\n\n    return {\n      ExportDefaultSpecifier() {\n        hasDefaultExport = true;\n      },\n\n      ExportSpecifier(node) {\n        if ((node.exported.name || node.exported.value) === 'default') {\n          hasDefaultExport = true;\n        } else {\n          specifierExportCount++;\n          namedExportNode = node;\n        }\n      },\n\n      ExportNamedDeclaration(node) {\n        // if there are specifiers, node.declaration should be null\n        if (!node.declaration) { return; }\n\n        const { type } = node.declaration;\n\n        if (\n          type === 'TSTypeAliasDeclaration'\n          || type === 'TypeAlias'\n          || type === 'TSInterfaceDeclaration'\n          || type === 'InterfaceDeclaration'\n        ) {\n          specifierExportCount++;\n          hasTypeExport = true;\n          return;\n        }\n\n        if (node.declaration.declarations) {\n          node.declaration.declarations.forEach(function (declaration) {\n            captureDeclaration(declaration.id);\n          });\n        } else {\n          // captures 'export function foo() {}' syntax\n          specifierExportCount++;\n        }\n\n        namedExportNode = node;\n      },\n\n      ExportDefaultDeclaration() {\n        hasDefaultExport = true;\n      },\n\n      ExportAllDeclaration() {\n        hasStarExport = true;\n      },\n\n      'Program:exit'() {\n        if (hasDefaultExport || hasStarExport || hasTypeExport) {\n          return;\n        }\n        if (target === 'single' && specifierExportCount === 1) {\n          context.report(namedExportNode, SINGLE_EXPORT_ERROR_MESSAGE);\n        } else if (target === 'any' && specifierExportCount > 0) {\n          context.report(namedExportNode, ANY_EXPORT_ERROR_MESSAGE);\n        }\n      },\n    };\n  },\n};\n"]}
|