Skip to content

Fixed use-namespace rule #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zans-laksa wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixed use-namespace rule #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 75 additions & 16 deletions core/eslint-plugin-mosaic/lib/rules/use-namespace.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ const types = {
'ArrowFunctionExpression'
].join(' > '),

ExportedFunction: [
'ExportNamedDeclaration',
'FunctionDeclaration'
].join(' > '),

isExportedClass: node => node.type === 'ClassDeclaration'
&& node.parent.type === 'ExportNamedDeclaration',

Expand All @@ -29,29 +34,35 @@ const types = {
&& node.parent.parent.type === 'VariableDeclaration'
&& node.parent.parent.parent.type === 'ExportNamedDeclaration',

isExportedFunction: node => node.type === 'FunctionDeclaration'
&& node.parent.type === 'ExportNamedDeclaration',

PromiseHandlerArrowFunction: [
[
"CallExpression",
"[callee.type='MemberExpression']",
"[callee.object.name!=/.+Dispatcher/]",
":matches(",
"[callee.property.name='then'], ",
"[callee.property.name='catch']",
[
"[callee.property.name='then']",
"[callee.property.name='catch']",
"[callee.property.name='finally']"
].join(', '),
")"
].join(''),
'ArrowFunctionExpression'
].join(' > '),

isPromiseHandlerArrowFunction: (node) => {
const { parent } = node;
const promiseHandlerNames = ['then', 'catch'];
const promiseHandlerNames = ['then', 'catch', 'finally'];

return (
node.type === 'ArrowFunctionExpression'
&& parent.type === 'CallExpression'
&& parent.callee.type === 'MemberExpression'
&& !(parent.callee.object.name || "").endsWith('Dispatcher')
&& promiseHandlerNames.includes(parent.callee.property.name)
&& parent.type === 'CallExpression'
&& parent.callee.type === 'MemberExpression'
&& !(parent.callee.object.name || "").endsWith('Dispatcher')
&& promiseHandlerNames.includes(parent.callee.property.name)
);
},

Expand All @@ -62,26 +73,38 @@ const types = {
if (types.isPromiseHandlerArrowFunction(node)) {
return 'promise handler arrow function';
}

if (types.isExportedArrowFunction(node)) {
return 'exported arrow function';
}

if (types.isExportedClass(node)) {
return 'exported class';
}

if (types.isExportedFunction(node)) {
return 'exported function';
}
}
};

const getProperParentNode = (node) => {
if (types.isExportedClass(node)) {
return node.parent;
}

if (types.isExportedArrowFunction(node)) {
return node.parent.parent.parent;
}

if (types.isPromiseHandlerArrowFunction(node)) {
return node;
}

if (types.isExportedFunction(node)) {
return node.parent;
}

return {};
};

Expand All @@ -96,13 +119,48 @@ const getNamespaceCommentForNode = (node, sourceCode) => {
};

const collectFunctionNamespace = (node, stack) => {
if (node.type === 'CallExpression') {
const { type } = node;

switch (type) {
case 'ArrowFunctionExpression':
const name = node.body?.callee?.name;

if (node.parent?.arguments?.indexOf(node) === 1) {
stack.push('catch');
}

if (name) {
stack.push(name);
}

break;
case 'CallExpression':
if (node.callee.type === 'MemberExpression') {
stack.push(node.callee.property.name);
collectFunctionNamespace(node.callee.object, stack);
} else if (node.callee.type === 'Identifier') {
stack.push(
node.callee?.property?.name,
node.callee?.object?.name
|| node.callee?.object?.callee?.name
|| node.callee?.object?.callee?.property?.name
);
} else {
stack.push(node.callee.name);
}

break;
case 'Identifier':
stack.push(node.name);
break;
case 'MethodDefinition':
stack.push(node.key.name);
break;
case 'VariableDeclarator':
case 'FunctionDeclaration':
case 'ClassDeclaration':
stack.push(node.id.name);
}

if (node.parent) {
collectFunctionNamespace(node.parent, stack);
}
};

Expand All @@ -114,11 +172,11 @@ const getNodeNamespace = (node) => {
} else if (node.type === 'ClassDeclaration') {
stack.push(node.id.name);
} else {
collectFunctionNamespace(node.parent, stack);
collectFunctionNamespace(node, stack);
}

// not using path.sep on purpose
return stack.reverse().join('/');
return stack.filter(Boolean).reverse().join('/');
};

const prepareFilePath = (pathname) => {
Expand Down Expand Up @@ -181,14 +239,14 @@ const generateNamespace = (node, context) => {
preparePackageName(packageName),
// Trim post-fixes if they are not present
...prepareFilePath(toFile)
].join('/').replace(
].filter(Boolean).join('/').replace(
// Convert to pascal-case, and trim "-"
/\b[a-z](?=[a-z]{2})/g,
(letter) => letter.toUpperCase()
).split('-').join('');

// Do not transform code to uppercase / lowercase it should be written alright
return `${pathname}/${getNodeNamespace(node)}`;
return [pathname, getNodeNamespace(node)].filter(Boolean).join('/');
};

const extractNamespaceFromComment = ({ value: comment = '' }) => {
Expand All @@ -215,7 +273,8 @@ module.exports = {
[[
types.ExportedClass,
types.PromiseHandlerArrowFunction,
types.ExportedArrowFunction
types.ExportedArrowFunction,
types.ExportedFunction
].join(',')](node) {
const namespaceComment = getNamespaceCommentForNode(node, context.getSourceCode()) || { value: '' };
const namespaceCommentString = namespaceComment.value.split('@namespace').pop().trim();
Expand Down
1 change: 1 addition & 0 deletions core/eslint-plugin-mosaic/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
"test": "mocha tests --recursive"
},
"dependencies": {
"@tilework/mosaic-dev-utils": "^0.1.6",
"eslint-traverse": "^1.0.0",
"requireindex": "~1.1.0"
},
Expand Down
2 changes: 1 addition & 1 deletion yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14140,7 +14140,7 @@ parent-module@^1.0.0:
"@types/node" "^12.0.0"
"@types/react" "^17.0.0"
"@types/react-dom" "^17.0.0"
parent-extension "file:../../Library/Caches/Yarn/v4/npm-parent-ts-react-app-0.2.0-f6930b41-4ef2-479f-950c-e8e52601fe6c-1626261981277/node_modules/parent-ts-react-app/packages/parent-extension"
parent-extension "file:../../../.cache/yarn/v4/npm-parent-ts-react-app-0.2.0-7016304a-1c74-4395-8956-cf1f72745d0c-1631749526470/node_modules/parent-ts-react-app/packages/parent-extension"
react "^17.0.1"
react-dom "^17.0.1"
react-scripts "4.0.3"
Expand Down