Table of Contents generated with DocToc
- Import the project via
File > New > Project from Existing Sources...
OR from theImport Project
option of the splash menu - Select the checkout of
intellij-elixir
directory - Select "Import project from external model" from the radio button group
- Select Gradle from the external models
- Click Next
- In "Import Project from Gradle"
- When the "Gradle Project Data to Import" dialog pops up
- When the "Import Gradle Projects" dialog pops up
- Install Kotlin Plugin
Gradle will handle all dependency management, including fetching the Intellij IDEA platform specified in gradle.properties
, so you can use a normal JDK instead of setting up an "Intellij Platform Plugin SDK".
NOTE: The tests require some additional dependencies which Gradle will fetch for you. You must have Elixir and Hex installed for Gradle to compile some of the dependencies for running the tests. You can run individual JUnit tests via the JUnit run configuration type, but note that some tests require additional setup which the Gradle test
task does for you, and these tests won't work when run outside Gradle without some additional work. See build.gradle
for details.
NOTE: If you're having trouble running the plugin against Intellij IDEA 14.1 on Mac, see this comment.
You can run ./gradlew runIde
or ./gradlew test
.
- Open the Gradle Tool Window (
View > Tool Windows > Gradle
OR from the Gradle button on the right tool button bar) - Expand
Elixir (root) > Tasks
- Expand
intellij
- Right-click
runIde
- Select
Create 'intellij-elixir' [runIde]
- Expand
verification
- Right-click
test
- Select
Create 'intellij-elixir' [test]
JetBrains plugins are able to set the text attribute values for TextAttributeKey
s that are unique to the plugin by using additionalTextAttributes
entries in src/META-INF/plugin.xml
. If you have a Color Scheme for Elixir you like, you can propose it as the default for a named theme by extracting the additionTextAttributes
file
from an Exported Settings .jar
.
- Preferences > Editor > Colors & Fonts > Elixir
- Customize the colors
- Click "Save As" to name the Scheme (
My $SCHEME_NAME
)_
- File > Export Settings
- Click "Select None"
- Check "Editor Colors"
- Change the "Export settings to:" path to a place you can easily access it in the terminal
- Click "OK"
mkdir settings
cd settings
jar xf $SAVE_DIRECTORY/settings.jar
mv colors/colors/My\ $SCHEME_NAME.icls $INTELLIJ_ELIXIR/colorSchemes/ElixirSCHEME_NAME.xml
($SCHEME_NAME
will beDefault
,Darcula
or another shared theme name.)- Remove all elements except for
scheme attributes
. - Remove the outer
scheme
tag - Rename the
attributes
tag tolist
. - Add
<?xml version='1.0'?>
to the top of the file
- In
plugin.xml
inside theidea-plugin extensions[defaultExtensionNs="com.intellij"]
tag, add a new additionalTextAttribute tag:<additionalTextAttributes file="colorSchemes/Elixir$SCHEME_NAME.xml" scheme="SCHEME_NAME"/>
The documentation files (CHANGELOG.md
, CONTRIBUTING.md
, README.md
,
and UPGRADING.md
) all have table of contents generated by
doctoc
.
Install doctoc
(globally) using npm
npm install -g doctoc
Then regenerate the table of contents using doctoc
doctoc .