dependents / detective-typescript Goto Github PK

View Code? Open in Web Editor NEW

54.0 3.0 24.0 921 KB

Get the dependencies of a TypeScript module

JavaScript 100.00%

typescript detective

detective-typescript's Introduction

Dependents

Navigate front-end codebases in Sublime Text 2/3

For updates, follow @getDependents.

Currently supports JavaScript (AMD, CommonJS, and ES6) and CSS Preprocessor (Sass and Stylus) codebases.

Installation

You can install Dependents via Package Control.

Don't see it? Try reinstalling Package Control. Alternatively, add the repository and install it:

Package Control -> Add Repository
Enter https://github.com/dependents/Dependents
Package Control -> Install Package
Choose Dependents

Nodejs Dependency

You must have Node.js installed on your system. Anything v0.10 and above is fine.

Note: The Node.js windows installer will add the install directory to the PATH variable but you must reboot to reload it.

NVM Users

NVM will install Nodejs outside of the standard binary location. If you encounter an error where your Node executable cannot be found, please override the node_path in User settings:

Preferences -> Package Settings -> Dependents -> Settings - User

{
  "node_path": "path/to/the/node/install/directory"
}

This will allow Dependents to find the Node binary for every codebase

Bindings

To more swiftly and conveniently trigger the package's commands both key and mouse bindings are provided.

Key bindings

By default, the following key bindings have been supplied:

OSX:

Jump to dependency: Command + Option + Right arrow
Find Dependents: Command + Option + Up arrow
Copy path to clipboard: Command + Shift + C

Windows and Linux:

Jump to dependency: Ctrl + Shift + Down arrow
Find Dependents: Ctrl + Shift + Up arrow

Mouse bindings

By default, the following key bindings have been supplied:

OSX:

Jump to dependency: Command + Option + Click on the dependency item
Find Dependents: Command + Shift + Click anywhere in document

Windows and Linux:

Jump to dependency: Ctrl + Alt + Click on the dependency item
Find Dependents: Ctrl + Shift + Click anywhere in document

Reporting an issue

You can get console logs via View -> Show Console.

Paste those logs into the body of your issue.

Feel free to chat with me on Gitter if you need help or ping me @mrjoelkemp.

License

(Creative Commons Attribution NoDerivs (CC-ND)](https://tldrlegal.com/license/creative-commons-attribution-noderivs-(cc-nd))

The no derivatives creative commons license is straightforward; you can take a work released under this license and re-distribute it but you can’t change it.

detective-typescript's People

Contributors

Stargazers

Watchers

detective-typescript's Issues

Add support for es6 import specifier details

Currently, given an import such as import { Foo, Bar } from './utilities', the returned dependencies will only give ['utilities'], and no other details about what specifically was imported.

For example, the previous import in the page.ts file:

// Directory Structure
├── page.ts
└── utilities
    ├── index.ts
    ├── foo.ts
    ├── bar.ts
    └── baz.ts

// utilities/index.ts
export * from './foo'
export * from './bar'
export * from './baz'

These details would be incredibly useful in other places such as dependency-tree so that the specific imports could be traced.

Currently when getting the dependencies for page.ts it would be utilities/index.ts, and utilities/index.ts would depend on foo, bar, and baz. This gives the appearance that page.ts depends on foo, bar, and baz, even though it only imports Foo and Bar.

I would be happy to PR this improvement to this package if this is an acceptable addition. When implementing it, I would add an opt-in config option to retrieve the extra import declaration data, and then pass it to the onAfterFile callback for use in other locations.

Publish in NPM registry

Hi there,

the README.md suggests running

npm install detective-typescript

Unfortunately there is no such package in the npmjs.com registry.

Could you please publish it or redirect me to the correct package?

Thanks!

wonderful with ts files but breaks w/ tsx files

thank you for this excellent tool :)

I've been using this with a typescript application and today I added a tsx file and found that detective-typescript throws an error which looks like this,

{ index: 727,
  lineNumber: 48,
  column: 14,
  message: '\'>\' expected.' }

what is the best way to resolve this? will you publish this module to npm?

Support ESM typescript modules

If your tsconfig.json has "module": "ES2020" or later (e.g you are outputting ESM and not CJS), TypeScript doesn't rewrite import './foo' to import './foo.js' in the transpiled output - instead you have to use import './foo.js' in your .ts file.

This module then breaks because it (quite reasonably) detects './foo.js' as a dependency which of course doesn't exist.

I've hacked round it by replacing the file extension here and here but it doesn't take into account if ./foo.js does actually exist and that's what you meant to import. I don't know the AST well enough to make that change, but a simple fs.existsSync should be enough?

Another workaround is to run the dep checker over the transpiled output instead of the ts source, but then you lose any import type declarations, so it's not ideal.

Refs: https://devblogs.microsoft.com/typescript/announcing-typescript-4-7/#type-in-package-json-and-new-extensions

Fails to recognize import expressions

In some situations the detective fails to recognize ImportExpression (import('...')) that imports a tsx file. In that case the imports that are inside the file that got imported by that expression are not recognised.

Repository to reproduce the issue:
https://github.com/leanazulyoro/test_depscheck

npm install
npm run deps:check
It will fail with Fail! Modules in package.json not used in code: lodash even when lodash is imported in TestFile2.ts
change the extension of TestFile.tsx to TestFile.ts and it works fine. So the issue might be in the @fatso83/detective-tsx package, that uses the typescript-detective's tsx version.