atom-community/atom-community.github.io

The Atom Community website.

Atom Community Website

Atom Community website powered by rocket.

Uses TypeDoc for introspection.

Development

pnpm install
pnpm dev

atom-community.github.io's Issues

[Security] Workflow main.yml is using vulnerable action wagoid/commitlint-github-action

The workflow main.yml is referencing action wagoid/commitlint-github-action using references v2. However this reference is missing the commit bf83d2b35c4177779d047f464b48d9907f2c5201 which may contain fix to the some vulnerability.
The vulnerability fix that is missing by actions version could be related to:
(1) CVE fix
(2) upgrade of vulnerable dependency
(3) fix to secret leak and others.
Please consider to update the reference to the action.

[api]: some typescript types do not render properly

Some complex types are not rendering properly

See for example https://github.com/atom-community/atom-ide-base/blob/1120181f51973a13bee8dd899a8accbc115182f8/types-packages/code-actions.d.ts#L38

This should render as something like

(diagnostic: Diagnostic, editor: Atom.TextEditor) => Promise<CodeAction[]>

Instead, our type renderer just throws its hands up and renders an empty string:

The relevant code lives in https://github.com/atom-community/atom-community.github.io/blob/master/docs/_includes/_joiningBlocks/_layoutApi/content/20-api.njk#L21

Part of the problem is that our input is TypeDoc reflection JSON, and we're trying to turn that back into TypeScript snippets. We haven't covered every case yet.

Relevant upstream PR: TypeStrong/typedoc#1216

This package, or code from it, may be of use: https://www.npmjs.com/package/typedoc-plugin-typescript-declaration

Dark theme

My poor eyes! For those that prefer a dark screen, this white background can be overwhelming.

For an example implementation using our docs framework rocket, see https://github.com/apollo-elements/apollo-elements/blob/master/docs/_assets/variables.css

Cannot update @rocket/cli and @rocket/lanuch

Description

It seems these have some hidden dependencies and breaking changes. They cannot be updated.

See #25

download links

Make the download links (for atom.exe) easily visible on https://atom-community.github.io/ website

thank you

Download links in the website

@autumnblazey could you make a PR to add the download links to the website?

Originally posted by @aminya in atom-community/atom#456 (comment)

The Search bar doesn't find anything

Description

Preliminary Roadmap

With the Atom IDE Community project getting more traction we would like to share our roadmap / planning for it here. This roadmap is in a preliminary state, and has been briefly outlined on the #atom-ide Slack channel a couple of days ago.

We provide this as an issue here, so the community can take part of the decision making process and give their direct feedback to the planning.

At the moment of writing the Atom IDE Community project hosts the following released packages:

• atom-ide-datatip
• atom-ide-definitions
• atom-ide-signature-help

There is the planning for those:

1. polish atom-ide-datatip, which is already in version 0.9; 1.0 can be delivered as soon as we have diagnostic tooltips in place and fix the potential bugs with multiple overlays
2. polish atom-ide-signature-help. Here we are only working on bug reports and issues at the moment; looks like not many lsp have signature help implemented anyway.
3. polish atom-ide-definitions , in which we want to add hyperclick style functionality to jump to the source on cmd/ctrl+click.

There is one new project having started right now:

4. progress on atom-ide-diagnostics and provide initial set of features incl. gutter, highlighter, panel and overlay for issues in the source code. It also supports Code Actions on those issues (if available).

There are also a couple of ideas for packages to be written next:

5. start atom-ide-console, which can be used to stream log and diagnostic messages (error, warn, info) into a panel from various sources and optionally allows to jump to the source of the issue. Console can be used by various atom-ide packages to show output and process in a panel on the bottom of the screen.

6. start atom-ide-outline, which shows an outline view of the structure of the current file in the editor, and allows you to jump around easily. Project wide symbol search is also a topic we would like to cover and support.

7. start atom-ide-formatter, which uses the lsp to format a file or a section in a document. It provides also capabilities for automatic formatting of a file on save.

8. start atom-ide-tester, which offers testing features not found in the lsp, but are still required for a decent IDE experience. It automatically scans your workspace for unit test cases and can execute them on your behalf. Any issues or the status is displayed in a panel so you will always know if your source code behaves as desired. It provides language specific tester plugins and will be developed on concepts and ideas of the original Atom Tester package(s).

9. start atom-ide-builder, which offers build features not found in the lsp, but are still required for a decent IDE experience. It can build your project via various build providers and shows the status of the current / recent build in a panel. It provides language specific build extensions and will be developed on concepts and ideas of the original Atom Build package(s).

Update the content of the website

Atom community has surpassed its initial goal, and the content of the current website is out of date. We should market the organization as an independent community-driven effort, and we need to focus on the many features and packages offered.

The installation procedure has also changed. As of now, the installation of "atom-ide-base" would install everything automatically.

We don't need to mention the old ide-ui package and the history of Nuclide and Facebook. Especially, because in the future versions, we will not allow/recommend simultaneous running of ide-ui due to the conflicts and the bugs it creates for our packages (example).

Other than few minor things, the atomic packages cover all the things ide-ui provides and much more. The license files already cover the "possible" use of code from nuclide.