diff --git a/Dockerfile b/Dockerfile index 2600834..aa35b75 100644 --- a/Dockerfile +++ b/Dockerfile @@ -12,7 +12,7 @@ RUN apk --no-cache add openjdk11=11.0.4_p4-r1 \ FROM alpine:3.10.1 LABEL maintainer="Haruaki Tamada" \ - 9rules-version="1.0.0" \ + 9rules-version="1.1.0" \ description="Checking tool for object oriented exercises by nine rules. " COPY --from=base /opt/openjdk-11-minimal /opt/openjdk-11-minimal diff --git a/README.md b/README.md index e2a5d74..76532ad 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ The demo was executed the following commands. ```sh $ tree src/test/resources/hello/src/main/java/ // The result of tree command was printed. -$ java -jar target/9rules-1.0-SNAPSHOT.jar src/test/resources/hello/src/main/java/ +$ java -jar target/9rules-1.1.0-SNAPSHOT.jar src/test/resources/hello/src/main/java/ // ... skip src/test/resources/hello/src/main/java/sample/hello/HelloWorld.java line: 10, setter method found. @@ -120,7 +120,9 @@ If it is hard to obey the rules shown in above, we can lower the validating leve Container images for Docker of 9rules are: * [`tamada/9rules`](https://hub.docker.com/r/tamada/9rules) - * `1.0.0-v2`, `latest` + * `1.1.0`, `latest` +* [`tamada/9rules`](https://hub.docker.com/r/tamada/9rules) + * `1.0.0-v2` To run the 9rules by the docker container: diff --git a/pom.xml b/pom.xml index 66265ea..2fb9fcb 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ com.github 9rules - 1.0.1-SNAPSHOT + 1.1.0 jar 9rules @@ -67,6 +67,12 @@ + + + src/main/resources + true + + org.apache.maven.plugins diff --git a/src/main/resources/resources/help.txt b/src/main/resources/resources/help.txt index dff8c56..2314d24 100644 --- a/src/main/resources/resources/help.txt +++ b/src/main/resources/resources/help.txt @@ -1,3 +1,4 @@ +9rules version ${project.version} java -jar 9rules.jar [OPTIONS] OPTIONS: diff --git a/src/scripts/9rules.sh b/src/scripts/9rules.sh index 0d31fc5..a09f2ee 100755 --- a/src/scripts/9rules.sh +++ b/src/scripts/9rules.sh @@ -1,6 +1,6 @@ #! /bin/sh -VERSION=1.0.1-SNAPSHOT +VERSION=1.1.0 CELLAR=. java -jar $CELLAR/9rules-${VERSION}.jar $@ diff --git a/src/site/config.toml b/src/site/config.toml index 67facad..9729811 100644 --- a/src/site/config.toml +++ b/src/site/config.toml @@ -20,22 +20,22 @@ pygmentsStyle = "pygments" [menu] [[menu.nav]] - name = "Home" + name = ":house: Home" url = "/" weight = 1 [[menu.nav]] - name = "Description" + name = ":page_facing_up: Description" url = "/description/" weight = 2 [[menu.nav]] - name = "Install" + name = ":anchor: Install" url = "/install/" weight = 3 [[menu.nav]] - name = "Usage" + name = ":running: Usage" url = "/usage/" weight = 4 [[menu.nav]] - name = "About" + name = ":smile: About" url = "/about/" weight = 5 diff --git a/src/site/content/_index.md b/src/site/content/_index.md index 759788c..a79098d 100644 --- a/src/site/content/_index.md +++ b/src/site/content/_index.md @@ -1,23 +1,25 @@ --- -title: 9rules +title: ":house: 9rules" --- ## Table of Contents -* [Description](description) -* [Installation](install) - * [Homebrew](install#homebrew) - * [Install yourself](install#install-yourself) - * [Requirements](install#requirements) -* [Usage](usage) - * [Usage of 9rules](example#usage-of-9rules) - * [Example](usage#example) - * [Help](usage#help) - * [Demo](usage#demo) -* [About the Project](about) - * [Contribution](about#contribution) - * [Authors](about#authors) - * [Discussion](about#discussion) - * [License](about#license) +* [:page_facing_up: Description](description) +* [:anchor: Installation](install) + * [:beer: Homebrew](install#beer-homebrew) + * [:muscle: Install yourself](install#muscle-install-yourself) + * [:briefcase: Requirements](install#briefcase-requirements) +* [:running: Usage](usage) + * [:fork_and_knife: Usage of 9rules](usage#fork_and_knife-usage-of-9rules) + * [:balloon: Example](usage#balloon=example) + * [:information_source: Help](usage#information_source-help) + * [:confetti_ball: Demo](usage#confetti_ball-demo) + * [:whale: Docker](usage#whale-docker) +* [:smile: About the Project](about) + * [:hammer_and_wrench: How to contribute the project](about#hammer_and_wrench-how-to-contribute-the-project) + * [:man_office_worker: Authors :woman_office_worker:](about#man_office_worker-authors-woman_office_worker) + * [:jack_o_lantern: Icons of 9rules](about#jack_o_lantern-icons-of-9rules) + * [:speech_balloon: Discussion](about#speech_balloon-discussion) + * [:scroll: License](about#scroll-license) diff --git a/src/site/content/about.md b/src/site/content/about.md index 4c3fd6f..c4a11e7 100644 --- a/src/site/content/about.md +++ b/src/site/content/about.md @@ -1,12 +1,12 @@ --- -title: About the project +title: ":smile: About the project" --- [![Gitter](https://badges.gitter.im/9rules/Lobby.svg)](https://gitter.im/9rules/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat)](https://github.com/tamada/9rules/blob/master/LICENSE) -## Contribution +## :hammer_and_wrench: How to contribute the project 1. Fork the project. ([https://github.com/tamada/9rules/fork](https://github.com/tamada/9rules/fork)) 2. Create a feature branch. (`git switch -c FEATURE_BRANCH_NAME`) @@ -17,21 +17,21 @@ title: About the project 7. Create a new pull request. 8. Confirm all checks pass. -## Authors +## :man_office_worker: Authors :woman_office_worker: * {{< githubuser tamada >}} [Haruaki Tamada](https://github.com/tamada) -## Icons of 9rules +## :jack_o_lantern: Icons of 9rules {{< figure src="/9rules/images/logo.svg" alt="9rules logo" width="64" >}} If you use the logo, please use [logo.svg](https://tamada.github.io/9rules/images/logo.svg) or [logo.png](https://tamada.github.io/9rules/images/logo.png), both images are located on https://tamada.github.io/9rules/images/. -## Discussion +## :speech_balloon: Discussion [![Gitter](https://badges.gitter.im/9rules/Lobby.svg)](https://gitter.im/9rules/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) -## License +## :scroll: License [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat)](https://github.com/tamada/9rules/blob/master/LICENSE) diff --git a/src/site/content/description.md b/src/site/content/description.md index 0176d04..e4462f6 100644 --- a/src/site/content/description.md +++ b/src/site/content/description.md @@ -1,5 +1,5 @@ --- -title: Description +title: ":page_facing_up: Description" --- ## Rules diff --git a/src/site/content/install.md b/src/site/content/install.md index 15f0bc6..619ea0f 100644 --- a/src/site/content/install.md +++ b/src/site/content/install.md @@ -1,8 +1,8 @@ --- -title: Install +title: ":anchor: Install" --- -## Homebrew +## :beer: Homebrew Install 9rules via [Homebrew](https://brew.sh), simply run: @@ -13,7 +13,7 @@ $ brew install ninerules `9rules` command (wrapper for shell script) will be installed. -## Install yourself +## :muscle: Install yourself ```sh $ git clone https://github.com/tamada/9rules.git @@ -21,7 +21,7 @@ $ cd 9rules $ mvn package ``` -## Requirements +## :briefcase: Requirements * Runtime * Java 8 or later. @@ -29,6 +29,7 @@ $ mvn package * Maven 3.x * Dependencies * JDT Core 3.10.0 + * Vavr 0.10.3 * Dependencies (the Unit Tests) * JUnit 4.12 * Hamcreset all 1.3 diff --git a/src/site/content/usage.md b/src/site/content/usage.md index 640d025..edd66cb 100644 --- a/src/site/content/usage.md +++ b/src/site/content/usage.md @@ -1,15 +1,15 @@ --- -title: Usage +title: ":running: Usage" --- -## Usage of 9rules +## :fork_and_knife: Usage of 9rules 9rules is an executable jar, therefore, simply type ```java -jar 9rules-VERSION.jar```, and specified java source codes and source code directory. Then, the tool checks each java source code and reports the results of the check. -## Example +## :balloon: Example We assume that the project was cloned and compiled with [Maven 3](http://maven.apache.org/). @@ -50,7 +50,7 @@ src/test/resources/hello/src/main/java/sample/hello/Launcher.java line: 10, method is too long (over 3 lines). ``` -## Help +## :information_source: Help ```sh java -jar 9rules.jar [OPTIONS] @@ -106,16 +106,17 @@ the tool ignore all rules by specifying the annotation, and checks all rules wit In the future version, the tool will arrange the annotations for ignoring each rule. -## Demo +## :confetti_ball: Demo ![demo](/9rules/images/demo.gif) -## Docker +## :whale: Docker The docker container images are provided at DockerHub as the following repository. * [tamada/9rules](https://hub.docker.com/r/tamada/9rules) (tamada/9rules) - * `1.0.0-v2`, `latest` + * `1.1.0`, `latest` + * `1.0.0-v2` To run the 9rules by docker. diff --git a/src/site/layouts/_default/single.html b/src/site/layouts/_default/single.html new file mode 100644 index 0000000..3527a48 --- /dev/null +++ b/src/site/layouts/_default/single.html @@ -0,0 +1,4 @@ +{{ define "main" }} +

{{ .Title | emojify }}

+ {{ .Content | emojify }} +{{ end }} diff --git a/src/site/layouts/index.html b/src/site/layouts/index.html index 969aea9..36cfea3 100644 --- a/src/site/layouts/index.html +++ b/src/site/layouts/index.html @@ -1,7 +1,7 @@ {{ define "main" }} -

{{ .Title }}

+

{{ .Title | emojify }}

-{{ .Content }} +{{ .Content | emojify }}
    {{ $pages := where site.RegularPages "Type" "in" site.Params.mainSections }} @@ -10,7 +10,7 @@

    {{ .Title }}

    {{ $dateFormat := $.Site.Params.dateFormat | default "Jan 2, 2006" }} {{ .PublishDate.Format $dateFormat }} - {{ .Title }} + {{ .Title | emojify }} {{ end }} diff --git a/src/site/layouts/partials/head.html b/src/site/layouts/partials/head.html index 5fc86b7..951af0a 100644 --- a/src/site/layouts/partials/head.html +++ b/src/site/layouts/partials/head.html @@ -16,5 +16,5 @@ {{ partial "katex.html" . }} - {{ .Title }} | {{ $.Site.Title }} + {{ .Title | emojify }} | {{ $.Site.Title | emojify }} diff --git a/src/test/java/com/github/ninerules/MainTest.java b/src/test/java/com/github/ninerules/MainTest.java index 70671c5..9f07402 100644 --- a/src/test/java/com/github/ninerules/MainTest.java +++ b/src/test/java/com/github/ninerules/MainTest.java @@ -51,16 +51,17 @@ public void testHelpMessage() throws Exception{ String output = new String(out.toByteArray()); String[] lines = output.split(System.getProperty("line.separator")); - assertThat(lines.length, is(10)); - assertThat(lines[0], is("java -jar 9rules.jar [OPTIONS] ")); - assertThat(lines[1], is("")); - assertThat(lines[2], is("OPTIONS:")); - assertThat(lines[3], is(" --strict: Strictly level check (Default).")); - assertThat(lines[4], is(" --general: General level check.")); - assertThat(lines[5], is(" --rough: Rough level check.")); - assertThat(lines[6], is(" --help: Print this message and exit.")); - assertThat(lines[7], is("")); - assertThat(lines[8], is("ARGUMENTS:")); - assertThat(lines[9], is(" Directories include Java source files, and Java source files.")); + assertThat(lines.length, is(11)); + assertThat(lines[0], is("9rules version 1.1.0")); + assertThat(lines[1], is("java -jar 9rules.jar [OPTIONS] ")); + assertThat(lines[2], is("")); + assertThat(lines[3], is("OPTIONS:")); + assertThat(lines[4], is(" --strict: Strictly level check (Default).")); + assertThat(lines[5], is(" --general: General level check.")); + assertThat(lines[6], is(" --rough: Rough level check.")); + assertThat(lines[7], is(" --help: Print this message and exit.")); + assertThat(lines[8], is("")); + assertThat(lines[9], is("ARGUMENTS:")); + assertThat(lines[10], is(" Directories include Java source files, and Java source files.")); } }