Skip to content

Commit 99ba42d

Browse files
authored
Merge pull request #12 from EtienneMiret/9-create-samples
Add some usage samples.
2 parents f23804e + 0b3a167 commit 99ba42d

File tree

19 files changed

+708
-0
lines changed

19 files changed

+708
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ compileSass {
6262
noErrorCss ()
6363
6464
// Watch sass files in sourceDir for changes
65+
// (Default is to not to watch, compile once and terminate)
6566
watch ()
6667
6768
// Source map style:
@@ -75,6 +76,31 @@ compileSass {
7576
}
7677
```
7778

79+
## Samples
80+
81+
### Simple
82+
83+
The easiest way to use this plugin is to apply it, along with the war
84+
plugin, and put your sass files under `src/main/sass`.
85+
See [samples/simple](samples/simple/build.gradle).
86+
87+
### Without the war plugin
88+
89+
If you’re not using the war plugin,
90+
you need to explicitly call the `compileSass` task.
91+
Usually, this is done by making another task depend on it.
92+
93+
Furthermore, the output will probably need to be consumed by that other task.
94+
See [samples/jar](samples/jar/build.gradle) for an example with the `java`
95+
plugin and its `jar` task.
96+
97+
### Watching for changes
98+
99+
The `watch ()` option prevents the `compileSass` task to terminates.
100+
It is therefore better used on a copy of this task that isn’t a dependency
101+
of the `assemble` task.
102+
See [samples/watch](samples/watch/build.gradle).
103+
78104
[1]: https://gradle.org/
79105
[2]: https://sass-lang.com/dart-sass
80106
[3]: https://docs.gradle.org/current/userguide/war_plugin.html

samples/jar/build.gradle

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
/*
2+
* Using this plugin while creating a jar rather than a war:
3+
* - apply it,
4+
* - apply the `java` plugin,
5+
* - configure the `jar` task to gather the output of the `compileSass` task and
6+
* - put the sass sources under `src/main/sass`.
7+
*
8+
* In this configuration, the `style.scss` file gets compiled to a `style.css`
9+
* and a `style.css.map` files at the root of the jar.
10+
*/
11+
12+
plugins {
13+
id 'java'
14+
id 'io.miret.etienne.sass' version '1.1.2'
15+
}
16+
17+
jar {
18+
dependsOn compileSass
19+
from compileSass.outputDir
20+
}
21+
22+
/*
23+
* Since this plugin is updated less often than the sass compiler,
24+
* it’s probably a good idea to specify a recent sass release.
25+
*/
26+
sass {
27+
version = '1.35.2'
28+
}
57.3 KB
Binary file not shown.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
distributionBase=GRADLE_USER_HOME
2+
distributionPath=wrapper/dists
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-6.0.1-bin.zip
4+
zipStoreBase=GRADLE_USER_HOME
5+
zipStorePath=wrapper/dists

samples/jar/gradlew

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
#!/usr/bin/env sh
2+
3+
#
4+
# Copyright 2015 the original author or authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#
18+
19+
##############################################################################
20+
##
21+
## Gradle start up script for UN*X
22+
##
23+
##############################################################################
24+
25+
# Attempt to set APP_HOME
26+
# Resolve links: $0 may be a link
27+
PRG="$0"
28+
# Need this for relative symlinks.
29+
while [ -h "$PRG" ] ; do
30+
ls=`ls -ld "$PRG"`
31+
link=`expr "$ls" : '.*-> \(.*\)$'`
32+
if expr "$link" : '/.*' > /dev/null; then
33+
PRG="$link"
34+
else
35+
PRG=`dirname "$PRG"`"/$link"
36+
fi
37+
done
38+
SAVED="`pwd`"
39+
cd "`dirname \"$PRG\"`/" >/dev/null
40+
APP_HOME="`pwd -P`"
41+
cd "$SAVED" >/dev/null
42+
43+
APP_NAME="Gradle"
44+
APP_BASE_NAME=`basename "$0"`
45+
46+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
47+
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
48+
49+
# Use the maximum available, or set MAX_FD != -1 to use that value.
50+
MAX_FD="maximum"
51+
52+
warn () {
53+
echo "$*"
54+
}
55+
56+
die () {
57+
echo
58+
echo "$*"
59+
echo
60+
exit 1
61+
}
62+
63+
# OS specific support (must be 'true' or 'false').
64+
cygwin=false
65+
msys=false
66+
darwin=false
67+
nonstop=false
68+
case "`uname`" in
69+
CYGWIN* )
70+
cygwin=true
71+
;;
72+
Darwin* )
73+
darwin=true
74+
;;
75+
MINGW* )
76+
msys=true
77+
;;
78+
NONSTOP* )
79+
nonstop=true
80+
;;
81+
esac
82+
83+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
84+
85+
# Determine the Java command to use to start the JVM.
86+
if [ -n "$JAVA_HOME" ] ; then
87+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
88+
# IBM's JDK on AIX uses strange locations for the executables
89+
JAVACMD="$JAVA_HOME/jre/sh/java"
90+
else
91+
JAVACMD="$JAVA_HOME/bin/java"
92+
fi
93+
if [ ! -x "$JAVACMD" ] ; then
94+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
95+
96+
Please set the JAVA_HOME variable in your environment to match the
97+
location of your Java installation."
98+
fi
99+
else
100+
JAVACMD="java"
101+
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
102+
103+
Please set the JAVA_HOME variable in your environment to match the
104+
location of your Java installation."
105+
fi
106+
107+
# Increase the maximum file descriptors if we can.
108+
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
109+
MAX_FD_LIMIT=`ulimit -H -n`
110+
if [ $? -eq 0 ] ; then
111+
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
112+
MAX_FD="$MAX_FD_LIMIT"
113+
fi
114+
ulimit -n $MAX_FD
115+
if [ $? -ne 0 ] ; then
116+
warn "Could not set maximum file descriptor limit: $MAX_FD"
117+
fi
118+
else
119+
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
120+
fi
121+
fi
122+
123+
# For Darwin, add options to specify how the application appears in the dock
124+
if $darwin; then
125+
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
126+
fi
127+
128+
# For Cygwin or MSYS, switch paths to Windows format before running java
129+
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
130+
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
131+
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
132+
JAVACMD=`cygpath --unix "$JAVACMD"`
133+
134+
# We build the pattern for arguments to be converted via cygpath
135+
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
136+
SEP=""
137+
for dir in $ROOTDIRSRAW ; do
138+
ROOTDIRS="$ROOTDIRS$SEP$dir"
139+
SEP="|"
140+
done
141+
OURCYGPATTERN="(^($ROOTDIRS))"
142+
# Add a user-defined pattern to the cygpath arguments
143+
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
144+
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
145+
fi
146+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
147+
i=0
148+
for arg in "$@" ; do
149+
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
150+
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
151+
152+
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
153+
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
154+
else
155+
eval `echo args$i`="\"$arg\""
156+
fi
157+
i=`expr $i + 1`
158+
done
159+
case $i in
160+
0) set -- ;;
161+
1) set -- "$args0" ;;
162+
2) set -- "$args0" "$args1" ;;
163+
3) set -- "$args0" "$args1" "$args2" ;;
164+
4) set -- "$args0" "$args1" "$args2" "$args3" ;;
165+
5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
166+
6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
167+
7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
168+
8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
169+
9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
170+
esac
171+
fi
172+
173+
# Escape application args
174+
save () {
175+
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
176+
echo " "
177+
}
178+
APP_ARGS=`save "$@"`
179+
180+
# Collect all arguments for the java command, following the shell quoting and substitution rules
181+
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
182+
183+
exec "$JAVACMD" "$@"

samples/jar/settings.gradle

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
pluginManagement {
2+
includeBuild '../..'
3+
}
4+
5+
rootProject.name = 'jar-sample'
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
p {
2+
text-align: justify;
3+
text-indent: 4em;
4+
}
5+
6+
a {
7+
color: blue;
8+
text-decoration: none;
9+
10+
&:hover {
11+
text-decoration: underline;
12+
}
13+
}

samples/simple/build.gradle

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/*
2+
* Simplest usage of this plugin:
3+
* - apply it,
4+
* - apply the war plugin and
5+
* - put the sass sources under `src/main/sass`.
6+
*
7+
* In this configuration, the `style.scss` file gets compiled to a `style.css`
8+
* and a `style.css.map` files at the root of the war.
9+
*/
10+
11+
plugins {
12+
id 'war'
13+
id 'io.miret.etienne.sass' version '1.1.2'
14+
}
57.3 KB
Binary file not shown.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
distributionBase=GRADLE_USER_HOME
2+
distributionPath=wrapper/dists
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-6.0.1-bin.zip
4+
zipStoreBase=GRADLE_USER_HOME
5+
zipStorePath=wrapper/dists

0 commit comments

Comments
 (0)