Skip to content
This repository has been archived by the owner on Mar 15, 2021. It is now read-only.

Commit

Permalink
Merge branch 'release/2.0.3'
Browse files Browse the repository at this point in the history
# Conflicts:
#	README.md
#	pom.xml
  • Loading branch information
agabrys committed Jul 26, 2018
2 parents e2d4d53 + f7dfcc5 commit 085a8e2
Show file tree
Hide file tree
Showing 10 changed files with 71 additions and 55 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# CSS Splitter Maven Plugin Changelog

## 2.0.3
Dependencies:
* Upgraded [CSS Parser](http://cssparser.sourceforge.net/) from 0.9.25 to 0.9.26 ([#31](https://github.com/gabrysbiz/css-splitter-maven-plugin/issues/31))

[See documentation](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.3/)

## 2.0.2
Bugs:
* Fixed regex patterns should not be created needlessly ([#30](https://github.com/gabrysbiz/css-splitter-maven-plugin/issues/30))
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,25 @@ This plugin splits [CSS](http://www.w3.org/Style/CSS/) stylesheets to smaller fi
For more information read the [split](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.2/split-mojo.html) goal documentation or take a look into [examples](#examples).

# Goals Overview
* [css-splitter:split](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.2/split-mojo.html) - splits [CSS](http://www.w3.org/Style/CSS/) stylesheets to smaller files ("parts") which contain maximum [X](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.2/split-mojo.html#maxRules) rules
* [css-splitter:split](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.3/split-mojo.html) - splits [CSS](http://www.w3.org/Style/CSS/) stylesheets to smaller files ("parts") which contain maximum [X](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.3/split-mojo.html#maxRules) rules

# Requirements
The plugin to run requires:
* Java 6 or higher
* Maven 3 or higher

# Usage
General instructions on how to use the CSS Splitter Maven Plugin can be found on the [usage](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.2/usage.html) page. Some more specific use cases are described in the examples given below. Last but not least, users occasionally contribute additional examples, tips or errata to the plugin's [wiki](https://github.com/gabrysbiz/css-splitter-maven-plugin/wiki) page.
General instructions on how to use the CSS Splitter Maven Plugin can be found on the [usage](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.3/usage.html) page. Some more specific use cases are described in the examples given below. Last but not least, users occasionally contribute additional examples, tips or errata to the plugin's [wiki](https://github.com/gabrysbiz/css-splitter-maven-plugin/wiki) page.

In case you still have questions regarding the plugin's usage, please have a look at the [FAQ](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.2/faq.html).
In case you still have questions regarding the plugin's usage, please have a look at the [FAQ](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.3/faq.html).

If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in the [issue tracker](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.2/issue-tracking.html). When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from the [source repository](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.2/source-repository.html) and will find supplementary information in the [guide to helping with Maven](http://maven.apache.org/guides/development/guide-helping.html).
If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in the [issue tracker](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.3/issue-tracking.html). When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from the [source repository](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.3/source-repository.html) and will find supplementary information in the [guide to helping with Maven](http://maven.apache.org/guides/development/guide-helping.html).

# Examples
To provide you with better understanding of some usages of the CSS Splitter Maven Plugin, you can take a look into the following examples:
* [Using include/exclude patterns](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.2/examples/patterns.html)
* [Multiple source/output directories](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.2/examples/multiple-directories.html)
* [Output file structure (imports' tree)](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.2/examples/output-file-structure.html)
* [Using cache token](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.2/examples/cache-token.html)
* [Code compression](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.2/examples/code-compression.html)
* [Using include/exclude patterns](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.3/examples/patterns.html)
* [Multiple source/output directories](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.3/examples/multiple-directories.html)
* [Output file structure (imports' tree)](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.3/examples/output-file-structure.html)
* [Using cache token](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.3/examples/cache-token.html)
* [Code compression](http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.3/examples/code-compression.html)

18 changes: 9 additions & 9 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@

<groupId>biz.gabrys.maven.plugins</groupId>
<artifactId>css-splitter-maven-plugin</artifactId>
<version>2.0.2</version>
<version>2.0.3</version>
<packaging>maven-plugin</packaging>
<name>CSS Splitter Maven Plugin</name>
<description>Splits CSS stylesheets to smaller files ("parts") which contain maximum X rules.</description>
<url>http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.2/</url>
<url>http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.3/</url>

<inceptionYear>2015</inceptionYear>
<organization>
Expand Down Expand Up @@ -92,7 +92,7 @@
<dependency>
<groupId>net.sourceforge.cssparser</groupId>
<artifactId>cssparser</artifactId>
<version>0.9.25</version>
<version>0.9.26</version>
</dependency>
<dependency>
<groupId>com.yahoo.platform.yui</groupId>
Expand Down Expand Up @@ -122,7 +122,7 @@
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
<version>2.19.0</version>
<version>2.20.0</version>
<scope>test</scope>
</dependency>
</dependencies>
Expand Down Expand Up @@ -185,7 +185,7 @@
</plugin>
<plugin>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>2.9</version>
<version>3.0.0</version>
</plugin>
<plugin>
<artifactId>maven-resources-plugin</artifactId>
Expand Down Expand Up @@ -357,13 +357,13 @@
<reportSets>
<reportSet>
<reports>
<report>cim</report>
<report>ci-management</report>
<report>dependencies</report>
<report>issue-tracking</report>
<report>license</report>
<report>issue-management</report>
<report>licenses</report>
<report>summary</report>
<report>scm</report>
<report>project-team</report>
<report>team</report>
</reports>
</reportSet>
</reportSets>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
* <li>parses it using the <a href="http://cssparser.sourceforge.net/">CSS Parser</a> (parser removes all comments)</li>
* <li>splits parsed document to "parts"</li>
* <li>builds imports' tree</li>
* <li>writes to files</li>
* <li>writes "parts" to files</li>
* </ol>
* <p>
* During split process the plugin can divide "standard style" and <code>&#64;media</code> rules, which size is bigger
Expand Down Expand Up @@ -205,16 +205,16 @@ public class SplitMojo extends AbstractMojo {
protected String[] excludes = new String[0];

/**
* The maximum number of <a href="http://www.w3.org/Style/CSS/">CSS</a> rules in single "part".<br>
* The maximum number of <a href="http://www.w3.org/Style/CSS/">CSS</a> rules in a single "part".<br>
* <b>Notice</b>: all values smaller than <tt>1</tt> are treated as <tt>4095</tt>.
* @since 1.0.0
*/
@Parameter(property = "css.splitter.maxRules", defaultValue = MAX_RULES_DEFAULT_VALUE)
protected int maxRules;

/**
* The plugin fails the build when a number of <a href="http://www.w3.org/Style/CSS/">CSS</a> rules in source file
* exceeds this value.<br>
* The plugin fails the build when a number of the <a href="http://www.w3.org/Style/CSS/">CSS</a> rules in a source
* file exceed this value.<br>
* <b>Notice</b>: all values smaller than <tt>1</tt> are treated as <tt>2147483647</tt>.
* @since 1.0.0
*/
Expand All @@ -231,7 +231,7 @@ public class SplitMojo extends AbstractMojo {
protected int maxImports;

/**
* The plugin fails the build when a number of <code>&#64;import</code> depth level exceed this value. The plugin
* The plugin fails a build when a number of <code>&#64;import</code> depth levels exceed this value. The plugin
* ignores <code>&#64;import</code> operations that come from the source code.<br>
* <b>Notice</b>: all values smaller than <tt>1</tt> are treated as <tt>4</tt>.
* @since 1.0.0
Expand Down Expand Up @@ -265,7 +265,7 @@ public class SplitMojo extends AbstractMojo {
protected boolean nonstrict;

/**
* Defines whether the plugin allows to use "star hack" in stylesheets. "Star hack" works only in Internet Explorer
* Defines whether the plugin allows using "star hack" in stylesheets. "Star hack" works only in Internet Explorer
* browsers - versions 7 and older. Example:
*
* <pre>
Expand All @@ -290,7 +290,7 @@ public class SplitMojo extends AbstractMojo {
protected boolean compress;

/**
* Defines column number after which the plugin will insert a line break. From
* Defines a column number after which the plugin will insert a line break. From
* <a href="http://yui.github.io/yuicompressor/">YUI Compressor</a> documentation:<blockquote>Some source control
* tools do not like files containing lines longer than, say 8000 characters. The line break option is used in that
* case to split long lines after a specific column. Specify 0 to get a line break after each rule in
Expand All @@ -302,7 +302,7 @@ public class SplitMojo extends AbstractMojo {
protected int compressLineBreak;

/**
* Defines cache token type which will be added to <code>&#64;import</code> links in destination
* Defines a cache token type which will be added to <code>&#64;import</code> links in destination
* <a href="http://www.w3.org/Style/CSS/">CSS</a> stylesheets. Available options:
* <ul>
* <li><b>custom</b> - text specified by the user</li>
Expand All @@ -315,7 +315,7 @@ public class SplitMojo extends AbstractMojo {
protected String cacheTokenType;

/**
* Defines cache token parameter name which will be added to <code>&#64;import</code> links in destination
* Defines a cache token parameter name which will be added to <code>&#64;import</code> links in destination
* <a href="http://www.w3.org/Style/CSS/">CSS</a> stylesheets.<br>
* <b>Notice</b>: ignored when <a href="#cacheTokenType">cache token type</a> is equal to <tt>none</tt>.
* @since 1.0.0
Expand Down
10 changes: 10 additions & 0 deletions xdocs/changelog.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@
</properties>

<body>
<section id="release-2.0.3" name="Release 2.0.3">
<p>Dependencies:</p>
<ul>
<li>
Upgraded <a href="http://cssparser.sourceforge.net/">CSS Parser</a> from 0.9.25 to 0.9.26
(<a href="https://github.com/gabrysbiz/css-splitter-maven-plugin/issues/31">#31</a>)
</li>
</ul>
</section>
<section id="release-2.0.2" name="Release 2.0.2">
<p>Bugs:</p>
<ul>
Expand All @@ -15,6 +24,7 @@
(<a href="https://github.com/gabrysbiz/css-splitter-maven-plugin/issues/30">#30</a>)
</li>
</ul>
<p><a href="http://css-splitter-maven-plugin.projects.gabrys.biz/2.0.2/">See documentation</a></p>
</section>
<section id="release-2.0.1" name="Release 2.0.1">
<p>Bugs:</p>
Expand Down
4 changes: 2 additions & 2 deletions xdocs/examples.xml.vm
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@
</tr>
<tr class="b">
<td><a href="examples/output-file-structure.html">Output file structure (imports' tree)</a></td>
<td>This example shows how output file structure will change depending on the configuration.</td>
<td>This example shows how the output file structure will change depending on the configuration.</td>
</tr>
<tr class="a">
<td><a href="examples/cache-token.html">Using cache token</a></td>
<td>This example describes how to enable addition of cache token to <code>@import</code> links.</td>
<td>This example describes how to enable addition of the cache token to <code>@import</code> links.</td>
</tr>
<tr class="a">
<td><a href="examples/code-compression.html">Code compression</a></td>
Expand Down
26 changes: 13 additions & 13 deletions xdocs/examples/cache-token.xml.vm
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<body>
<section name="Using cache token">
<p>
You can control the addition of the cache token to <code>@import</code> links using three parameters:
You can control the addition of the cache token to <code>@import</code> links using the following three parameters:
</p>
<ol>
<li>
Expand All @@ -26,10 +26,10 @@
<p>List of examples:</p>
<ul>
<li>
<a href="#custom-type">Cache token with custom text</a>
<a href="#custom-type">Cache token with a custom text</a>
</li>
<li>
<a href="#date-type">Cache token with build time</a>
<a href="#date-type">Cache token with a build time</a>
</li>
<li>
<a href="#none-type">Disable addition of the cache token</a>
Expand All @@ -38,11 +38,11 @@
</section>
<section id="custom-type" name="Cache token with custom text">
<p>
If you want to use custom text as cache token, you need to:
If you want to use a custom text as cache token, you need to:
</p>
<ul>
<li>set <a href="../split-mojo.html#cacheTokenType">cacheTokenType</a> to <code>custom</code></li>
<li>fill <a href="../split-mojo.html#cacheTokenValue">cacheTokenValue</a> with custom text</li>
<li>set the <a href="../split-mojo.html#cacheTokenType">cacheTokenType</a> to <code>custom</code></li>
<li>fill the <a href="../split-mojo.html#cacheTokenValue">cacheTokenValue</a> with custom text</li>
</ul>
<pre>&lt;project&gt;
...
Expand Down Expand Up @@ -118,7 +118,7 @@
</section>
<section id="date-type" name="Cache token with build time">
<p>
If you want to add cache token with the build time, you need to set
If you want to add the cache token with the build time, you need to set the
<a href="../split-mojo.html#cacheTokenType">cacheTokenType</a> to <code>date</code>.
</p>
<pre>&lt;project&gt;
Expand Down Expand Up @@ -153,8 +153,8 @@
</p>
<ul>
<li>
fill <a href="../split-mojo.html#cacheTokenValue">cacheTokenValue</a> with
pattern for <code>SimpleDateFormat</code> object
fill the <a href="../split-mojo.html#cacheTokenValue">cacheTokenValue</a> with
a pattern for <code>SimpleDateFormat</code> object
</li>
<li>
change name of the cache token parameter
Expand Down Expand Up @@ -193,10 +193,10 @@
</section>
<section id="none-type" name="Disable addition of the cache token">
<p>
If you want to disable addition of cache token (default action), you need to set
<a href="../split-mojo.html#cacheTokenType">cacheTokenType</a> to <code>none</code>.
<a href="../split-mojo.html#cacheTokenParameter">cacheTokenParameter</a> and
<a href="../split-mojo.html#cacheTokenValue">cacheTokenValue</a> will be ignored.
If you want to disable addition of the cache token (default action), you need to set
the <a href="../split-mojo.html#cacheTokenType">cacheTokenType</a> to <code>none</code>.
The <a href="../split-mojo.html#cacheTokenParameter">cacheTokenParameter</a> and
the <a href="../split-mojo.html#cacheTokenValue">cacheTokenValue</a> will be ignored.
</p>
<pre>&lt;project&gt;
...
Expand Down
2 changes: 1 addition & 1 deletion xdocs/examples/code-compression.xml.vm
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
&lt;/build&gt;
&lt;project&gt;</pre>
<p>
Additionaly you can set the column number after which the plugin will insert a line break
Additionaly you can set a column number after which the plugin will insert a line break
by settng the <a href="../split-mojo.html#compressLineBreak">compressLineBreak</a> parameter.
From <a href="http://yui.github.io/yuicompressor/">YUI Compressor</a> documentation:
</p>
Expand Down
Loading

0 comments on commit 085a8e2

Please sign in to comment.