PT #153123095 Add readme for boot-properties
This commit is contained in:
51
atom-extensions/atom-boot-properties/README.MD
Normal file
51
atom-extensions/atom-boot-properties/README.MD
Normal file
@@ -0,0 +1,51 @@
|
||||
# Atom package for Spring Boot Application Properties
|
||||
|
||||
Atom package and Language Server providing support for editing `application.properties`
|
||||
and `application.yml` files containing Spring Boot configuration properties.
|
||||
|
||||
## Installation:
|
||||
|
||||
Install it from Atom `Install Packages`, search for `boot-properties`
|
||||
|
||||
## Usage:
|
||||
|
||||
The extension will automatically activate when you edit files with the following
|
||||
name patterns:
|
||||
|
||||
- `application.properties` => activates support for .properties file format.
|
||||
- `application.yml` => activates support for .yml file format.
|
||||
|
||||
For all other files select grammar to be `Spring-Boot-Properties` for `properties` file format or `Spring-Boot-Properties-YAML` for 'YAML' file format
|
||||
|
||||
# Developer notes
|
||||
|
||||
## Bulding and Running
|
||||
|
||||
To build all these pieces you normally only need to run:
|
||||
|
||||
npm install
|
||||
|
||||
Now you can link it to Atom:
|
||||
|
||||
apm link .
|
||||
|
||||
Open Atom or execute `Refresh Window` in the opened instance (Packages -> Command Palette -> Toggle then search for the command).
|
||||
|
||||
## Debugging
|
||||
|
||||
**Client Side Debugging**: Open Atom's `Developer Tools` view - View -> Developer -> Toggle Developer Tools
|
||||
|
||||
**Server Side Debugging**: Change `launchVmArgs(version)` implementation in `lib/main.js` to be:
|
||||
```
|
||||
launchVmArgs(version) {
|
||||
return Promise.resolve([
|
||||
'-Xdebug',
|
||||
'-agentlib:jdwp=transport=dt_socket,server=y,address=7999,suspend=n',
|
||||
'-Dorg.slf4j.simpleLogger.logFile=boot-properties.log',
|
||||
'-Dorg.slf4j.simpleLogger.defaultLogLevel=debug',
|
||||
]);
|
||||
}
|
||||
|
||||
```
|
||||
(Then setup the remote debugger from your IDE on the same port `7999`)
|
||||
|
||||
@@ -38,7 +38,6 @@ class BootPropertiesClient extends JavaProcessLanguageClient {
|
||||
'-Dorg.slf4j.simpleLogger.logFile=boot-properties.log',
|
||||
'-Dorg.slf4j.simpleLogger.defaultLogLevel=debug',
|
||||
]);
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user