andymoreland / tsunami Goto Github PK

View Code? Open in Web Editor NEW

31.0 1.0 5.0 473 KB

Typescript IDE for text editors (emacs, vscode)

TypeScript 69.07% Emacs Lisp 23.84% JavaScript 7.09%

typescript emacs vscode editor-plugin

tsunami's Introduction

How to Use From VSCode:

Install tsunami-code from the vscode extension market
Open a typescript project.
Run (tsu) Import Symbol
Enjoy!

How to Use From The CLI:

Run npm install -g @derander/tsunami
Use tsunami-imports aFile.ts anotherFile.tsx aThirdFile.ts 'src/\*\*/\*.ts'
Enjoy!

About:

Tsunami is a TypeScript analysis project built on top of the typescript compiler's interfaces. Features:

Auto-Import

Tsunami indexes the exports of the project it's executed in (as well as the exports of its dependencies) in order to determine the symbols that are available for import. It is capable of providing CodeEdits that import these symbols.

Move Symbol refactoring

Tsunami can re-write all imports in a project to reflect a symbols move from ModuleA to ModuleB. For example, it can rewrite all instances of:

import { a } from "../foo";

import { a } from "../../bar";

while respecting relative paths properly.

Import Formatting (coalescing, ordering)

Export indexing

Tsunami can answer the question "what symbols are available for import?" for arbitrary typescript modules.

tsunami's People

Contributors

Stargazers

Watchers

Forkers

brieb crazytoucan haosharon marwahaha

tsunami's Issues

Relative paths in quick pick have extra ../ sometimes

Windows issues

tsunami-code 0.5.1
VScode 1.8.1
Windows 10

I have few problems which makes this plugin totally unusable on Windows:

When importing symbol it rewrites all existing relative paths from ../../path/to/file to ..\..\path\to\file
Importing some symbol from project is resulting to absolute path name instead of relative one

Support specifying the location of the project root for a given workspace

Doesn't work if you open more than one repository in a single vscode window

Importing a symbol in a file without imports mangles first character

Completion popup is annyoing

Thanks for your plugin, with latest changes it works great on windows. I have few more issues now:

Popup appears inside // comments
Popup appears inside string literals "" or ''
Popup appears inside destructuring expressions
Property access expression. To reproduce this case hide TS completion popup (by moving cursor or pressing esc) then try to type again to complete statement. The popup will mix object properties with import completions.
It should not suggest import completion if there is local variable with same name as exported element.
May be there are few more contexts which are not making sense for completion import.

Also please make an option to disable import completion popup if these issues are hard to resolve (in this case it's better to wait for native TS auto-import implementation) .

VScode 1.8.1
Tsunami-vscode 0.5.2
Windows 10

Add "import symbol at point" command

Please add auto-import! :)

Please add unused import deletion! :)

Support configurable namespace alias imports

goal is to support importing, for example, lodash methods underneath a consistent namespace import.

Doesn't import typings for npm modules without a typings key

Remove trailing /index from imports in moduleResolution: node

In my project, I have folders which have an index.ts which re-export all "public" symbols from that folder. I want my imports to come from that folder when applicable:

// module/index.ts
export interface Foo {
  bar: string;
}

// other/file.ts
// current import emit:
import { Foo } from "../module/index";
// expected import emit:
import { Foo } from "../module";

Import preferentially from index files rather

User has internal module structure that re-exports symbols. Prefers that the symbols are exported from index files rather than from the source modules.

Support importing from one-level nested files

I have a package that exposes "namespaces" as one-level nested folders:

import { sym } from "mypackage";
import { AOptions } from "mypackage/modulea";
import { BOptions } from "mypackage/moduleb";

The second two imports above are not accessible from the root package, so Tsunami is unable to provide those import suggestions. In practice, they're implemented as root-level modulea.d.ts and moduleb.d.ts files.

In general, importing from not-package-root seems unideal. Perhaps this can go in a .tsunami file with hints for downstream projects, or a custom package.json key that Tsunami looks for?