Skip to content

[Documentation:Developer] Add new lint scripts to docs #671

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 4, 2025
Merged

[Documentation:Developer] Add new lint scripts to docs #671

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions _docs/developer/testing/linting_static_analysis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,13 @@ submitty_test php-lint --memory-limit 2G

## JavaScript Linting

The frontend JavaScript code Submitty uses is linted using [eslint](https://eslint.org/).
The frontend JavaScript code Submitty uses is linted using [eslint](https://eslint.org/). As with the PHP linter, `submitty_test` can be used as an alias for the `SUBMITTY_TEST.sh` script.

You can run eslint on your host system or on vagrant by navigating into the `site/`
```bash
submitty_test js-lint
```

Alternatively, you can run eslint on your host system or on vagrant by navigating into the `site/`
directory and running:

```bash
Expand All @@ -152,9 +156,13 @@ See also: [JavaScript Style Guide](/developer/coding_style_guide/javascript)

## CSS Linting

CSS is linted using [stylelint](https://stylelint.io/) in Submitty to enforce a consistent code style.
CSS is linted using [stylelint](https://stylelint.io/) in Submitty to enforce a consistent code style. As with the PHP linter, `submitty_test` can be used as an alias for the `SUBMITTY_TEST.sh` script.

```bash
submitty_test css-lint
```

You can run stylelint on your host system or on vagrant by navigating into the `site/`
Alternatively, you can run stylelint on your host system or on vagrant by navigating into the `site/`
directory and running:

```bash
Expand Down
Loading