kmulvey / bootstrap-builder Goto Github PK

Preprocess LESS to compile overrides for twbs/bootstrap

License: GNU Lesser General Public License v3.0

Java 84.43% CSS 15.57%

bootstrap-builder's Introduction

bootstrap-builder

Bootstrap Builder allows you to create override files in a subdirectory of bootstrap/less/ thus keeping the source files unchanges and easy to update from upstream.

Usage

java -jar bootstrap-builder-<version>-jar-with-dependencies.jar source_dir override_dir output_dir

Prerequisites

JRE 8 is not required but is highly reccomended as JRE6 is EOL
JRE 8: openjdk or oracle
maven 3

Quick start

Clone the repo: git clone [email protected]:kmulvey/bootstrap-builder.git.
mvn install
creating the binary jar: mvn clean compile assembly:single

Override file format

The format of this file looks similar to a diff file and tweaking an actual diff is a good way to get started.

Remove a property: line begins with a '-': - margin-left: 20px;
Add a property: line begins with a '+': + background: #333;
Remove a block: selector line begins with a '-'. There is no need to give the contents of the block as we are simply going to find that selector and remove the whole thing.

It is important that there not be any space in front of the +/-, they cannot have space or tabs before them.

-.well-small {
}

Add a block: selector line begins with a '+'.

+.well-large {
		padding: 24px;
		.border-radius(6px);
}

When changing a nested selector be sure to correctly specify the parent selectors

.btn{
		&:focus {
-		.tab-focus();
+		outline: none;
		}
}

A complete example

.well {
-	margin-bottom: 20px;
-	background-color: @wellBackground;
-	border: 1px solid darken(@well-bg, 7%);
+	border: 1px solid darken(@wellBackground, 70%);
		blockquote {
-		border-color: #ddd;
+		border-color: rgba(255, 255, 255);
		}
}
+.well-large {
	padding: 24px;
	.border-radius(6px);
}
-.well-small {
}

Change a selector: The first selector is what you are looking for, the second is what you are replacing it with. You can still put properties in the block. Be sure to put the {} at the end of the new selector.

button
%
.btn {
+	padding: 24px;
-	.border-radius(6px);
}

input[type="checkbox"],
input[type="text"],
input[type="button"] 
%
input[type="submit"],
input[type="reset"],
input[type="button"] {}

note: do not put comments at the end of a line, put them on their own line. White space at the end of lines also breaks. These should both be fixed at somne point.

Running tests

mvn test

bootstrap-builder's People

Contributors

Stargazers

Watchers

bootstrap-builder's Issues

change logging level via cli flags

need to be able to change the logging AppenderRef via cli args to the jar. The runners will need to read these args.

I think LoggerContext or LoggerConfig can be used to do this:
https://logging.apache.org/log4j/2.x/manual/architecture.html

deleting blocks always deletes the first one it finds

would need to check some of the contents to be sure its the correct one

rewrite Merge class so it is readable

there is currently a lot of zen in that class, below is a new design that should simplify things a bit:

https://github.com/kmulvey/bootstrap-builder/wiki/Merge-rewrite

linear runner needed

we need a runner that compiles one file at a time i.e. in a for() loop

Main.java should be renamed to ThreadedRunner.java
new file should be LinearRunner.java

they should both be able to run LessRunner.java

check path format in FileUtil.writeFile

File file = new File(dir + "/" + name);

this is unsafe as the "/" may have already been provided in dir or name

fontface

5 +@font-face{
6   font-family:'FranklinGothicMedium';
7   src: url(//:) format('no404'),
8   url('@{headingsFontPath}FranklinGothic-Med-webfont.woff') format('woff'),
9   url('@{headingsFontPath}FranklinGothic-Med-webfont.ttf') format('truetype'),

10 url('@{headingsFontPath}FranklinGothic-Med-webfont.svg') format('svg');
11 font-weight:400;
12 font-style:normal;
13 }

better exception capturing

we need to send better messages to the user when exception occur rather than printing a stack trace.

basically this test needs to pass and does not currently, this is because the regex that tries to determine if a % is within () does not work well. This regex lives on line 28 of Block.java. When done it can probably be combined with line 27. The whole reason for this regex is to differentiate between and update of the selector and a % in a normal selector (i.e. defaulting % values in a mixin signature)

@test
public void renameMixin() {
Block b = new Block(".box-shadow(@shadow)%.box-shadow(@ShadowA, @ShadowB:X, ...)");
b.process();
Assert.assertEquals("update", b.getAction());
Assert.assertEquals(".box-shadow(@shadow)", b.getSelector());
Assert.assertEquals(".box-shadow(@ShadowA,@ShadowB:X,...)", b.updated_selector[1]);
}

sample LESS
.box-shadow(@shadow)
%
.box-shadow(@ShadowA, @ShadowB:X, ...){

btw, this is a blocker for v2.3.2

space at the end of lines breaks things

update selectors

need to be able to do this:

-.btn-link,
-.btn-link:active,
-.btn-link[disabled] {
+.btn.btn-link,
+.btn.btn-link:active,
+.btn.btn-link[disabled] {
background-color: transparent;
background-image: none;
.box-shadow(none);

text-shadow: none;
}

too much trim()ing going on in Block.java

why call trim() after substring() ? It was already called in the constructor

comments in override files

this has gotten better for comments on their own line do not effect the next line however the following does not work:

```
// z-index: 2;
```

in my opinion you should not do that, you should just delete the rule entirely