Skip to content

Commit

Permalink
Fix version updates (#170)
Browse files Browse the repository at this point in the history
* update dependencies

* reformat with prettier

* fix eslint config issues
  • Loading branch information
Dando18 authored Dec 3, 2024
1 parent c179e27 commit dd2126e
Show file tree
Hide file tree
Showing 8 changed files with 884 additions and 961 deletions.
3 changes: 3 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,8 @@
"no-throw-literal": "warn",
"semi": "off"
},
"settings": {
"files": ["**/*.ts"]
},
"ignorePatterns": ["out", "dist", "**/*.d.ts"]
}
58 changes: 29 additions & 29 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,68 +2,68 @@

### 0.0.13

- use glob patterns to find job scripts instead of extensions. The glob patterns
can be specified with `slurm-dashboard.submit-dashboard.jobScriptPatterns`.
The old setting, `slurm-dashboard.submit-dashboard.jobScriptExtensions`, is
now deprecated and will be removed in a future version.
- collect node list data and display it in the job info display
- use glob patterns to find job scripts instead of extensions. The glob patterns
can be specified with `slurm-dashboard.submit-dashboard.jobScriptPatterns`.
The old setting, `slurm-dashboard.submit-dashboard.jobScriptExtensions`, is
now deprecated and will be removed in a future version.
- collect node list data and display it in the job info display

### 0.0.12

- adds ability to persist jobs in the job view so that they stay until
deleted. See the `slurm-dashboard.job-dashboard.persistJobs` setting.
- adds ability to persist jobs in the job view so that they stay until
deleted. See the `slurm-dashboard.job-dashboard.persistJobs` setting.

### 0.0.11

- lowered minimum required vscode version to 1.81.1 and added testing for more
vscode releases
- lowered minimum required vscode version to 1.81.1 and added testing for more
vscode releases

### 0.0.10

- added option `slurm-dashboard.slurm-backend.squeueUserArg` to enable passing
`--user=$USER` instead of `--me` to squeue for versions of Slurm older than
20.02
- added option `slurm-dashboard.slurm-backend.squeueUserArg` to enable passing
`--user=$USER` instead of `--me` to squeue for versions of Slurm older than
20.02

### 0.0.9

- bug fix: handle unlimited wall time for jobs
- bug fix: handle unlimited wall time for jobs

### 0.0.8

- handle all slurm output file patterns by getting the output file path from `scontrol`
- handle all slurm output file patterns by getting the output file path from `scontrol`

### 0.0.7

- fix submit issue, so now submitting jobs should work on all systems
- fix bug with parsing _Command_ column of squeue
- support for finding job output files when they contains special substitutions
(i.e. `output-%A.txt`)
- increased documentation
- fix submit issue, so now submitting jobs should work on all systems
- fix bug with parsing _Command_ column of squeue
- support for finding job output files when they contains special substitutions
(i.e. `output-%A.txt`)
- increased documentation

### 0.0.6

- enabling time formatting for multi-day jobs
- enabling time formatting for multi-day jobs

### 0.0.5

- add sorting in UI for jobs and job scripts; several options for sorting order
- more complete CI testing
- add sorting in UI for jobs and job scripts; several options for sorting order
- more complete CI testing

### 0.0.4

- added option to extrapolate job run times in the UI
- added option to extrapolate job run times in the UI

### 0.0.3

- update icons for job queue
- update icons for job queue

### 0.0.2

- update logo and readme
- update logo and readme

### 0.0.1

- initial release
- slurm support
- job queue view
- job script view
- initial release
- slurm support
- job queue view
- job script view
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ within the Run and Debug UI. All tests should pass.
You can also look at code coverage in the testing with `npm run coverage`.
Other useful developing commands are listed below:

- `npm run test -- {vscode_version}` -- run unit tests on vscode version
- `npm run coverage` -- collect code coverage data for unit tests
- `npm run check-format` -- check if the code is in the correct format
- `npm run format` -- format all files to the correct format
- `npm run package` -- create a vsix package for distributing extension
- `npm run test -- {vscode_version}` -- run unit tests on vscode version
- `npm run coverage` -- collect code coverage data for unit tests
- `npm run check-format` -- check if the code is in the correct format
- `npm run format` -- format all files to the correct format
- `npm run package` -- create a vsix package for distributing extension

### Testing Locally

Expand Down
98 changes: 49 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,50 +26,50 @@ planned.

This extension contributes the following settings:

- `slurm-dashboard.job-dashboard.showJobInfo`: Show all job metadata in the
job list. Default: `false`
- `slurm-dashboard.job-dashboard.promptBeforeCancel`: Prompt user before
canceling a job. Default: `true`
- `slurm-dashboard.job-dashboard.promptBeforeCancelAll`: Prompt user before
cancelling all jobs. Default: `true`
- `slurm-dashboard.job-dashboard.refreshInterval`: How many seconds between
refreshes of the job queue view. Set to `null` to turn off auto-refresh.
Default: `300`
- `slurm-dashboard.job-dashboard.extrapolationInterval`: Extrapolate the job
run times in the UI without querying the workload manager. Allows you to set
a high job-dashboard.refreshInterval, but still see more realistic job run
times. This has the danger of coming out of sync with the real times or not
portraying job completion/failure, so it is turned off by default. Provide a
number to specify the interval in seconds or `null` to disable
extrapolation. Default: `null`
- `slurm-dashboard.job-dashboard.persistJobs`: Keep completed jobs in the job
dashboard until they are removed with the X button. Default: `false`
- `slurm-dashboard.job-dashboard.useNativeIcons`: Instead of the job status
icons shipped with the extension, use VSCode native codicons. Default:
`false`
- `slurm-dashboard.job-dashboard.sortBy`: Sort the job list by this column.
Set to `null` to leave the order returned by the workload manager. Choices:
`id`, `name`, `time left`, `status`. Default: `null`
- [DEPRECATED] `slurm-dashboard.submit-dashboard.jobScriptExtensions`: Use
jobScriptPatterns setting instead. File extensions used to identify job
scripts. Default: `[".sbatch", ".slurm", ".job"]`
- `slurm-dashboard.submit-dashboard.jobScriptPatterns`: Glob patterns to
identify job scripts. Default: `["**/*.slurm", "**/*.sbatch", "**/*.job"]`
- `slurm-dashboard.submit-dashboard.promptBeforeSubmitAll`: Prompt user before
submitting all job scripts. Default: `true`
- `slurm-dashboard.submit-dashboard.sortBy`: Sort the job script list by this
column. Set to `null` to leave the order the glob pattern discovered the
files. Choices: `filename`, `rel path`, `last modified`, `newest`, `oldest`.
Default: `last modified`
- `slurm-dashboard.setJobWorkingDirectoryToScriptDirectory`: Launch job
scripts with the working directory as the location of the job script.
Default: `true`
- `slurm-dashboard.backend`: Scheduler backend. Choices: `slurm`, `debug`.
Default: `slurm`
- `slurm-dashboard.slurm-backend.squeueUserArg`: By default `--me` is passed
to squeue to get the users jobs. Slurm versions older than 20.02 do not
support `--me`. This settings provides a way to fallback to the `--user`
flag instead. Choices: `me`, `user`. Default: `me`
- `slurm-dashboard.job-dashboard.showJobInfo`: Show all job metadata in the
job list. Default: `false`
- `slurm-dashboard.job-dashboard.promptBeforeCancel`: Prompt user before
canceling a job. Default: `true`
- `slurm-dashboard.job-dashboard.promptBeforeCancelAll`: Prompt user before
cancelling all jobs. Default: `true`
- `slurm-dashboard.job-dashboard.refreshInterval`: How many seconds between
refreshes of the job queue view. Set to `null` to turn off auto-refresh.
Default: `300`
- `slurm-dashboard.job-dashboard.extrapolationInterval`: Extrapolate the job
run times in the UI without querying the workload manager. Allows you to set
a high job-dashboard.refreshInterval, but still see more realistic job run
times. This has the danger of coming out of sync with the real times or not
portraying job completion/failure, so it is turned off by default. Provide a
number to specify the interval in seconds or `null` to disable
extrapolation. Default: `null`
- `slurm-dashboard.job-dashboard.persistJobs`: Keep completed jobs in the job
dashboard until they are removed with the X button. Default: `false`
- `slurm-dashboard.job-dashboard.useNativeIcons`: Instead of the job status
icons shipped with the extension, use VSCode native codicons. Default:
`false`
- `slurm-dashboard.job-dashboard.sortBy`: Sort the job list by this column.
Set to `null` to leave the order returned by the workload manager. Choices:
`id`, `name`, `time left`, `status`. Default: `null`
- [DEPRECATED] `slurm-dashboard.submit-dashboard.jobScriptExtensions`: Use
jobScriptPatterns setting instead. File extensions used to identify job
scripts. Default: `[".sbatch", ".slurm", ".job"]`
- `slurm-dashboard.submit-dashboard.jobScriptPatterns`: Glob patterns to
identify job scripts. Default: `["**/*.slurm", "**/*.sbatch", "**/*.job"]`
- `slurm-dashboard.submit-dashboard.promptBeforeSubmitAll`: Prompt user before
submitting all job scripts. Default: `true`
- `slurm-dashboard.submit-dashboard.sortBy`: Sort the job script list by this
column. Set to `null` to leave the order the glob pattern discovered the
files. Choices: `filename`, `rel path`, `last modified`, `newest`, `oldest`.
Default: `last modified`
- `slurm-dashboard.setJobWorkingDirectoryToScriptDirectory`: Launch job
scripts with the working directory as the location of the job script.
Default: `true`
- `slurm-dashboard.backend`: Scheduler backend. Choices: `slurm`, `debug`.
Default: `slurm`
- `slurm-dashboard.slurm-backend.squeueUserArg`: By default `--me` is passed
to squeue to get the users jobs. Slurm versions older than 20.02 do not
support `--me`. This settings provides a way to fallback to the `--user`
flag instead. Choices: `me`, `user`. Default: `me`

Most notable is the `job-dashboard.refreshInterval` setting. The job queue view
refreshes its data at regular intervals. To avoid overloading the login nodes or
Expand Down Expand Up @@ -101,11 +101,11 @@ See the [Changelog](/CHANGELOG.md) for the entire change history.

### 0.0.13

- use glob patterns to find job scripts instead of extensions. The glob patterns
can be specified with `slurm-dashboard.submit-dashboard.jobScriptPatterns`.
The old setting, `slurm-dashboard.submit-dashboard.jobScriptExtensions`, is
now deprecated and will be removed in a future version.
- collect node list data and display it in the job info display
- use glob patterns to find job scripts instead of extensions. The glob patterns
can be specified with `slurm-dashboard.submit-dashboard.jobScriptPatterns`.
The old setting, `slurm-dashboard.submit-dashboard.jobScriptExtensions`, is
now deprecated and will be removed in a future version.
- collect node list data and display it in the job info display

## Contributing

Expand Down
12 changes: 6 additions & 6 deletions ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

Todo items:

- [ ] Better testing
- [ ] PBS support
- [ ] BSUB support
- [ ] Flux support
- [ ] job array support
- [ ] hierarchical view as option for _Job Scripts_ view
- [ ] Better testing
- [ ] PBS support
- [ ] BSUB support
- [ ] Flux support
- [ ] job array support
- [ ] hierarchical view as option for _Job Scripts_ view
29 changes: 29 additions & 0 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import typescriptEslint from "@typescript-eslint/eslint-plugin";
import tsParser from "@typescript-eslint/parser";
import stylisticTs from "@stylistic/eslint-plugin-ts";

export default [{
ignores: ["**/out", "**/dist", "**/*.d.ts"],
}, {
plugins: {
"@typescript-eslint": typescriptEslint,
"@stylistic/ts": stylisticTs,
},

languageOptions: {
parser: tsParser,
ecmaVersion: 6,
sourceType: "module",
},

files: ["**/*.ts"],

rules: {
"@typescript-eslint/naming-convention": "warn",
"@stylistic/ts/semi": "warn",
curly: "warn",
eqeqeq: "warn",
"no-throw-literal": "warn",
semi: "off",
},
}];
Loading

0 comments on commit dd2126e

Please sign in to comment.