Skip to content
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.

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

Improve PMD update procedure #174

Merged
merged 12 commits into from
Sep 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ jobs:
matrix:
os: [macos-latest, ubuntu-latest, windows-latest]
runs-on: ${{ matrix.os }}
defaults:
run:
shell: bash
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@ out
node_modules
.sfdx
.vscode-test
bin/pmd
bin/pmd.zip
pmd-packager/target
*.vsix
dist/
test/assets/project2 - with space/pmd-copy
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
script-shell=bash
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
### Added
### Changed

- Improve PMD update procedure by @adangel in [#174](https://github.com/ChuckJonas/vscode-apex-pmd/pull/174)

### Deprecated
### Removed
### Fixed
Expand Down
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,17 +67,33 @@ this output channel.

## Developing/Contributing

### Prerequisites

* node
* bash: npm calls shell scripts and therefore bash is needed. Under Windows, make sure to run npm from within git-bash.
* java: needs to be installed already. It is needed for executing PMD later on.

### Setup & Run

1. `git clone`
1. `npm install`
1. debug -> `run extension`

### Creating a installable vsix package

`npm run vscode:package`

This will create a file "apex-pmd-<version>.vsix", which can be directly installed in VS Code.

### Executing automated tests

`npm run test`

### Upgrading PMD

`npm run update-pmd`

Any pull request submitted with updates to PMD MUST BE "CHECKSUMED"!
This will check for the latest PMD version on github and update `config.pmdVersion` in `package.json`.

## Legal Stuff

Expand Down
237 changes: 0 additions & 237 deletions bin/pmd/LICENSE

This file was deleted.

Loading