Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/savetheclocktower/pulsar-ide-typescript-alpha

A Pulsar-native IDE provider package for TypeScript and JavaScript
https://github.com/savetheclocktower/pulsar-ide-typescript-alpha
Last synced: about 2 months ago
JSON representation
A Pulsar-native IDE provider package for TypeScript and JavaScript
Host: GitHub
URL: https://github.com/savetheclocktower/pulsar-ide-typescript-alpha
Owner: savetheclocktower
License: mit
Created: 2023-08-08T19:50:49.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-06-22T18:31:09.000Z (7 months ago)
Last Synced: 2024-06-23T01:44:33.570Z (7 months ago)
Language: JavaScript
Size: 471 KB
Stars: 4
Watchers: 3
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project

README

        # pulsar-ide-typescript-alpha

An attempt to write a non-invasive IDE provider for TypeScript and JavaScript.

_(The package name envisions that this could eventually be an official or semi-official Pulsar package, but it’s too early to presume that.)_

---

## IMPORTANT: New setting for v0.1.0 and above

This package used to use Pulsar’s built-in version of Node to run [typescript-language-server](https://www.npmjs.com/package/typescript-language-server), but recent versions of the language server require Node 18 or above, and Pulsar is stuck on version 14 until it can upgrade its underlying Electron version.

The solution is to supply your own version of Node so that `typescript-language-server` can run using the more modern version your project is probably already using. This is more hygienic anyway, and it’s only slightly more of a hassle.

Here’s how this works:

* If you don’t have Node installed on your system, or if your installed version is too old, you have [many options for installing the latest version of Node](https://nodejs.org/en/download/).

* The “Path to Node” setting (or `pulsar-ide-typescript-alpha.nodeBin`) is what will run the built-in `typescript-language-server`. Its default value is `node`; since Pulsar inherits your shell environment, this will usually resolve to the version of Node that would run if you typed `node` from whatever directory you used to launch Pulsar from the command line.

    Often this will just work — even with tools like [asdf](https://asdf-vm.com/) and [volta](https://volta.sh/) that use “shims” to manage multiple versions of Node.

    Even if you launch Pulsar another way, it’s pretty good at recreating your default shell environment, including your `PATH`, so it’s still worth seeing if the default configuration works.

* If it doesn’t work, you’ll see an error notification explaining that the language server failed to launch. You can open the package settings and supply a full, absolute path to a Node binary of version 18 or greater; you’ll know you’ve entered it properly when the error notification is replaced with a success notification.

* If you want to specify different Node paths for different projects, consider [project-config](https://web.pulsar-edit.dev/packages/project-config) or [atomic-management](https://web.pulsar-edit.dev/packages/atomic-management); either will allow you to set config values of `pulsar-ide-typescript-alpha.nodeBin` on a per-project basis. (Even this might be overkill, though. As long as you point it to a compatible version of Node, you should easily be able to use that version everywhere, even if it doesn’t always match your project’s version.)

### What if I use an older version of Node or TypeScript in my project?

You don’t need to upgrade the version of Node you use in your project; you just need one version of Node that can run the latest `typescript-language-server`. So in the short term, the solution might be to install a newer version of Node using a tool like [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md) or [asdf](https://asdf-vm.com/). You can then configure this package to use this newer version of Node _instead of_ inheriting the version of Node used in your shell environment.

`typescript-language-server` is theoretically backwards-compatible, as I understand it, so this should work fine. If it doesn’t, then please file an issue against the package and let me know. It might be worth it in the future to let the user opt into bringing their own version of `typescript-language-server` so that such projects can keep using a known older version of the language server instead of needing to stay on an older version of this package.

---

## What’s the philosophy?

IDE features are great when they make you feel productive, but bad when they get in your way. Because the line between “useful” and “invasive” will vary per person, we want to provide an IDE experience that is, above all, customizable:

* IDE “provider” packages (like this one) act as the “brain” behind a bunch of UI features.

* Each individual UI feature can be implemented by a different Pulsar package. Some of these packages are built into the core Pulsar editor and some are community packages.

* The user can pick and choose among those packages. If you want a maximal experience, you can install a whole slate of packages. If you want only a few features, you can pick only the packages you want, and uninstall or disable the ones you don’t.

* Provider packages **should not care** whether a consumer package is installed for a given service, nor should it mandate that any package be installed at all.

## What can it do that similar packages can’t?

### Symbol navigation

This package integrates with recent versions of Pulsar’s built-in `symbols-view` package.

You can view a comprehensive list of file symbols with Ctrl-R/Cmd-R:



Or search the entire project for symbols via Ctrl-Shift-R/Cmd-Shift-R:



Or use Ctrl-Alt-Down/Cmd-Opt-Down to jump to the definition of the symbol under the cursor — even if it’s in another file — then use Ctrl-Alt-Up/Cmd-Opt-Up to return to your original cursor position:

![jump-to-definition](https://github.com/savetheclocktower/pulsar-ide-typescript-alpha/assets/3450/c2158087-084a-4bda-999e-99b39fb403af)

### Ability to ignore certain diagnostic messages

This package allows you to ignore certain kinds of diagnostic messages. You can choose whether to ignore them altogether or just until the file is saved:



The latter is useful for annoying messages that point out “problems” in your code that you simply haven’t had a chance to fix yet because you’re _literally still typing_.

Diagnostic messages require the community `linter` package. The menu shown in the screenshot above is implemented by the community `intentions` package.

### Support for refactoring

You can place the cursor inside of any token and invoke a command to rename it. This package will be able to tell Pulsar which other usages of that symbol need to be renamed as well.

This feature requires the community `pulsar-refactor` package.

### Optional JavaScript support

Like `ide-typescript`, this package can be configured to start a language server for JavaScript-only projects. Enable the **Include JavaScript** setting in this package’s settings menu. No separate package is required.

A smaller feature set is available inside of JavaScript projects; autocompletion and symbol providers are sparser with their suggestions, and features like refactoring may not be available at all. Still, you’ll probably be impressed with what it can do.

## What does it do?

Install this package, then install any of the following packages to get special features:

* [autocomplete-plus](https://web.pulsar-edit.dev/packages/autocomplete-plus) (builtin)

  * See autocompletion options as you type

* [symbols-view](https://web.pulsar-edit.dev/packages/symbols-view) (builtin)

  * View and filter a list of symbols in the current file

  * View and filter a list of symbols across all files in the project

  * Jump to the definition of the symbol under the cursor

* [linter](https://web.pulsar-edit.dev/packages/linter) and [linter-ui-default](https://web.pulsar-edit.dev/packages/linter-ui-default)

  * View diagnostic messages as you type

* [intentions](https://web.pulsar-edit.dev/packages/intentions)

  * Open a menu to view possible code actions for a diagnostic message

  * Open a menu to view possible code actions for the file at large

* [atom-ide-definitions](https://web.pulsar-edit.dev/packages/atom-ide-definitions)

  * Jump to the definition of the symbol under the cursor

* [pulsar-outline-view](https://web.pulsar-edit.dev/packages/pulsar-outline-view)

  * View a hierarchical list of the file’s symbols

* [atom-ide-outline](https://web.pulsar-edit.dev/packages/atom-ide-outline)

  * View a hierarchical list of the file’s symbols

  * View the call hierarchy for a given file

* [atom-ide-datatip](https://web.pulsar-edit.dev/packages/atom-ide-datatip)

  * Hover over a symbol to see any related documentation, including method signatures

* [atom-ide-signature-help](https://web.pulsar-edit.dev/packages/atom-ide-signature-help)

  * View a function’s parameter signature as you type its arguments

* [atom-ide-code-format](https://web.pulsar-edit.dev/packages/atom-ide-code-format)

  * Invoke on a buffer (or a subset of your buffer) to reformat your code according to the language server’s settings

* [pulsar-refactor](https://web.pulsar-edit.dev/packages/pulsar-refactor)

  * Perform project-wide renaming of variables, methods, classes and types

* [pulsar-find-references](https://web.pulsar-edit.dev/packages/pulsar-find-references)

  * Place the cursor inside of a token to highlight other usages of that token

  * Place the cursor inside of a token, then view a `find-and-replace`-style “results” panel containing all usages of that token across your project

## Service list

This package **provides** the following services. Click on each link to find packages that can consume each service:

* [intentions:list](https://web.pulsar-edit.dev/packages?service=intentions:list&serviceType=consumed)

* [symbol.provider](https://web.pulsar-edit.dev/packages?service=symbol.provider&serviceType=consumed)

* [autocomplete.provider](https://web.pulsar-edit.dev/packages?service=autocomplete.provider&serviceType=consumed)

* [code-actions](https://web.pulsar-edit.dev/packages?service=code-actions&serviceType=consumed)

* [code-format.range](https://web.pulsar-edit.dev/packages?service=code-format.range&serviceType=consumed)

* [call-hierarchy](https://web.pulsar-edit.dev/packages?service=call-hierarchy&serviceType=consumed)

* [code-highlight](https://web.pulsar-edit.dev/packages?service=code-highlight&serviceType=consumed)

* [definitions](https://web.pulsar-edit.dev/packages?service=definitions&serviceType=consumed)

* [find-references](https://web.pulsar-edit.dev/packages?service=find-references&serviceType=consumed)

* [outline-view](https://web.pulsar-edit.dev/packages?service=outline-view&serviceType=consumed)

* [refactor](https://web.pulsar-edit.dev/packages?service=refactor&serviceType=consumed)

This package **consumes** the following services. Click on each link to find packages that can provide each service:

* [linter-indie](https://web.pulsar-edit.dev/packages?service=linter-indie&serviceType=provided)

* [datatip](https://web.pulsar-edit.dev/packages?service=datatip&serviceType=provided)

* [signature-help](https://web.pulsar-edit.dev/packages?service=signature-help&serviceType=provided)