Skip to content

Instantly share code, notes, and snippets.

@dsherret
Last active December 22, 2023 00:03
Show Gist options
  • Save dsherret/0bae87310ce24866ae22425af80a9864 to your computer and use it in GitHub Desktop.
Save dsherret/0bae87310ce24866ae22425af80a9864 to your computer and use it in GitHub Desktop.
Searches files for any exported declarations that aren't used in other files.
// this could be improved... (ex. ignore interfaces/type aliases that describe a parameter type in the same file)
import { Project, TypeGuards, Node } from "ts-morph";
const project = new Project({ tsConfigFilePath: "tsconfig.json" });
for (const file of project.getSourceFiles()) {
file.forEachChild(child => {
if (TypeGuards.isVariableStatement(child)) {
if (isExported(child))
child.getDeclarations().forEach(checkNode);
}
else if (isExported(child))
checkNode(child);
});
}
function isExported(node: Node) {
return TypeGuards.isExportableNode(node) && node.isExported();
}
function checkNode(node: Node) {
if (!TypeGuards.isReferenceFindableNode(node))
return;
const file = node.getSourceFile();
if (node.findReferencesAsNodes().filter(n => n.getSourceFile() !== file).length === 0)
console.log(`[${file.getFilePath()}:${node.getStartLineNumber()}: ${TypeGuards.hasName(node) ? node.getName() : node.getText()}`);
}
@zapo
Copy link

zapo commented Feb 9, 2019

This is super useful. Thank you guys for this snippet. We want to use that within our CI. Did you plan or be open to maintain it as a CLI node package ? I created a draft in https://github.com/zapo/unused-exports.ts that simply allows passing tsconfig in params, also include/exclude patterns for source files filtering and to return proper process exit code.

@OliverJAsh
Copy link

ts-simple-ast has been renamed to ts-morph, so the import will need updating. @dsherret Would you mind updating the gist?

@nadeesha
Copy link

nadeesha commented May 6, 2019

I've taken this idea a little bit further and built ts-prune: https://github.com/nadeesha/ts-prune

Thanks for the inspiration!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment