removed specs generation from pom.xml and add some doc for those who

want to build it
This commit is contained in:
Renaud Pawlak 2015-12-31 14:27:12 +01:00
parent e4139b27f2
commit 4e202984e6
2 changed files with 34 additions and 89 deletions

View File

@ -53,6 +53,40 @@ More info at http://www.jsweet.org.
- [Maven plugin](https://github.com/lgrignon/jsweet-maven-plugin) - [Maven plugin](https://github.com/lgrignon/jsweet-maven-plugin)
- [Gradle plugin](https://github.com/lgrignon/jsweet-gradle-plugin) - [Gradle plugin](https://github.com/lgrignon/jsweet-gradle-plugin)
## How to build
To build the `jsweet-transpiler` jars (in the project's directory):
```
> mvn package
```
To install the `jsweet-transpiler` artifact in your local Maven repository:
```
> mvn install
```
Note that current JUnit tests launch a Node.js instance for each test and will be quite slow (this will be improved). In order to easily test some changes locally without having to run all the tests, use the following command:
```
> mvn package -Dmaven.test.skip=true
```
or
```
> mvn install -Dmaven.test.skip=true
```
To generate the specifications from the Latex source file with [Pandoc](http://pandoc.org/):
```
> cd doc
> pandoc -r latex -w markdown_github --base-header-level=2 -s --toc --number-sections -B header.md -o jsweet-language-specifications.md jsweet-language-specifications.tex
> pandoc -r latex -w html5 --base-header-level=3 -o jsweet-language-specifications.html jsweet-language-specifications.tex
```
## License ## License
JSweet is under the Apache 2.0 Open Source license. JSweet is under the Apache 2.0 Open Source license.

89
pom.xml
View File

@ -114,96 +114,7 @@
<stylesheetfile>/var/www/apidocs/stylesheet.css</stylesheetfile> <stylesheetfile>/var/www/apidocs/stylesheet.css</stylesheetfile>
</configuration> </configuration>
</plugin> </plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>1.4.0</version>
<executions>
<execution>
<id>doc-markdown</id>
<goals>
<goal>exec</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<executable>pandoc</executable>
<workingDirectory>doc</workingDirectory>
<arguments>
<argument>-r</argument>
<argument>latex</argument>
<argument>-w</argument>
<argument>markdown_github</argument>
<argument>--base-header-level=2</argument>
<argument>-s</argument>
<argument>--toc</argument>
<argument>--number-sections</argument>
<argument>-B</argument>
<argument>header.md</argument>
<argument>-o</argument>
<argument>jsweet-language-specifications.md</argument>
<argument>jsweet-language-specifications.tex</argument>
</arguments>
</configuration>
</execution>
<execution>
<id>doc-html</id>
<goals>
<goal>exec</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<executable>pandoc</executable>
<workingDirectory>doc</workingDirectory>
<arguments>
<argument>-r</argument>
<argument>latex</argument>
<argument>-w</argument>
<argument>html5</argument>
<argument>--base-header-level=3</argument>
<argument>-o</argument>
<argument>jsweet-language-specifications.html</argument>
<argument>jsweet-language-specifications.tex</argument>
</arguments>
</configuration>
</execution>
</executions>
</plugin>
</plugins> </plugins>
<pluginManagement>
<plugins>
<!--This plugin's configuration is used to store Eclipse m2e settings only. It has no influence on the Maven build itself.-->
<plugin>
<groupId>org.eclipse.m2e</groupId>
<artifactId>lifecycle-mapping</artifactId>
<version>1.0.0</version>
<configuration>
<lifecycleMappingMetadata>
<pluginExecutions>
<pluginExecution>
<pluginExecutionFilter>
<groupId>
org.codehaus.mojo
</groupId>
<artifactId>
exec-maven-plugin
</artifactId>
<versionRange>
[1.4.0,)
</versionRange>
<goals>
<goal>exec</goal>
</goals>
</pluginExecutionFilter>
<action>
<ignore></ignore>
</action>
</pluginExecution>
</pluginExecutions>
</lifecycleMappingMetadata>
</configuration>
</plugin>
</plugins>
</pluginManagement>
</build> </build>
<dependencies> <dependencies>
<dependency> <dependency>