Skip to content
This repository was archived by the owner on Aug 7, 2023. It is now read-only.

Commit fdd4927

Browse files
committed
chore: update readme and changelog
1 parent 47151f7 commit fdd4927

File tree

2 files changed

+26
-24
lines changed

2 files changed

+26
-24
lines changed

CHANGELOG.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
## 0.9
2+
* Rewrote for StaticLint.jl (#119)
3+
14
## 0.8.2
25
* Making it work again on Julia v.1 >
36

README.md

+23-24
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ This linter plugin for [AtomLinter](https://atomlinter.github.io/)
44
provides an interface to [StaticLint.jl](https://github.com/julia-vscode/StaticLint.jl).
55
It will be used with files that have the `Julia` syntax.
66

7-
This is a fork that replaces Lint.jl with StaticLint.jl from the Julia VSCode plugin.
8-
97
![screenshot](https://raw.githubusercontent.com/takbal/linter-julia/master/Screenshot.gif)
108

119
## Developed on
@@ -15,31 +13,11 @@ This is a fork that replaces Lint.jl with StaticLint.jl from the Julia VSCode pl
1513
* [linter](https://atom.io/packages/linter)
1614
* tested on Ubuntu 18.04 and Windows
1715

18-
## Caveats
19-
20-
* The server needs a minute to spin up, then also some time to parse new Julia environments that this Atom instance
21-
have not seen before. A pop-up is shown when parsing a new environment starts (but not when it ends). After parsing finishes, you need to
22-
edit or reopen those files that are already in the editor for linting to start. If the environment had been already parsed, linting new files is immediate.
23-
* The edited file has to be saved at least once for linting to start. This is by design of the linter package (https://github.com/steelbrain/linter/issues/1235)
24-
* The environment for each file is guessed from its path. If this fails, Julia's default environment is assumed.
25-
* The symbols are rebuilt if the modification time of the Project.toml or the Manifest.toml files change, for example,
26-
you add, remove or update packages. Linting is not available during this rebuild.
27-
28-
## Internals
29-
30-
The code generates its private shared environment at the Julia depot in 'environments/linter-julia'. It also places a logfile there.
31-
32-
Guessing the environment works by walking upwards in the path and looking for Project.toml. If nothing found, the default
33-
environment is assumed. The project's root file is then looked for at the canonical X/src/X.jl etc. locations.
34-
35-
I know nothing of Atom development or js, so the changes are likely messy there, please revise. Atom seems to be
36-
unable to shut down the server process, so the server exits by polling Atom's PID right now.
37-
3816
## Installation
3917

4018
- Install the package through Atom's UI. You can also use the `apm` tool in the CLI:
41-
```bash
42-
$ apm install takbal/linter-julia
19+
```
20+
apm install linter-julia
4321
```
4422

4523
- You may need to tell linter-julia where to find the Julia executable
@@ -59,6 +37,27 @@ $ apm install takbal/linter-julia
5937
[Issues](https://github.com/AtomLinter/linter-julia/issues) and [pull requests]
6038
(https://github.com/AtomLinter/linter-julia/pulls) are welcome.
6139

40+
41+
## Caveats
42+
43+
* The server needs a minute to spin up, then also some time to parse new Julia environments that this Atom instance
44+
have not seen before. A pop-up is shown when parsing a new environment starts (but not when it ends). After parsing finishes, you need to
45+
edit or reopen those files that are already in the editor for linting to start. If the environment had been already parsed, linting new files is immediate.
46+
* The edited file has to be saved at least once for linting to start. This is by design of the linter package (https://github.com/steelbrain/linter/issues/1235)
47+
* The environment for each file is guessed from its path. If this fails, Julia's default environment is assumed.
48+
* The symbols are rebuilt if the modification time of the Project.toml or the Manifest.toml files change, for example,
49+
you add, remove or update packages. Linting is not available during this rebuild.
50+
51+
## Internals
52+
53+
The code generates its private shared environment at the Julia depot in 'environments/linter-julia'. It also places a logfile there.
54+
55+
Guessing the environment works by walking upwards in the path and looking for Project.toml. If nothing found, the default
56+
environment is assumed. The project's root file is then looked for at the canonical X/src/X.jl etc. locations.
57+
58+
I know nothing of Atom development or js, so the changes are likely messy there, please revise. Atom seems to be
59+
unable to shut down the server process, so the server exits by polling Atom's PID right now.
60+
6261
## CHANGELOG
6362

6463
[See the full CHANGELOG here.](https://github.com/AtomLinter/linter-julia/blob/master/CHANGELOG.md)

0 commit comments

Comments
 (0)