Skip to content

Commit bd28356

Browse files
NickDJMNickDJM
authored
feat(version): update to 1.0.0
* docs(usage): add basic information on how to use the plugins (#1) * feat(license): add isc license * feat(widths): add adjustable border-width variant * docs(global): add proper docs * docs(information): add more information about project * docs(border widths): add documentation * docs(temp): add placeholder templates * docs(classes): add btn-rounded documentation * docs(classes): add btn-squared documentation * docs(classes): add font-sizes documentation * feat(global): add commitizen ensure commits follow the same structure for readability. * docs(classes): update documentation structure * docs(classes): add documentation for col-count * docs(mixins): add documentation for media-ie * docs(other): add documentation for responsize typography * feat(version): update to 0.2.0 * feat(version): update to 0.2.0 * docs(usage): add basic information on how to use the plugins (#1) * feat(license): add isc license * feat(widths): add adjustable border-width variant * docs(global): add proper docs * docs(information): add more information about project * docs(border widths): add documentation * docs(temp): add placeholder templates * docs(classes): add btn-rounded documentation * docs(classes): add btn-squared documentation * docs(classes): add font-sizes documentation * feat(global): add commitizen ensure commits follow the same structure for readability. * docs(classes): update documentation structure * docs(classes): add documentation for col-count * docs(mixins): add documentation for media-ie * docs(other): add documentation for responsize typography * docs(community): add code of conduct * docs(community): add contributing guidelines * docs(community): add contribution documentation * docs(contribution): update pr steps * docs(contribution): fix links to issues * test(global): add lint and compiling tests * test(gulp): add initial testing setup * fix(plugin): rename squared buttons file * test(global): make tests work * chore(templates): add templates * docs(community): move code of conduct and contributing docs * chore(templates): add templates * chore(templates): add new templates * chore(templates): add new templates * chore(templates): remove old template * refactor(version): update to 1.0.0 * fix(repo): change repo url BREAKING CHANGE: The repository has changed. * docs(log): add changelog * refactor(version): update to 1.0.0
1 parent 8e87952 commit bd28356

21 files changed

+406
-4
lines changed

‎.eslintignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules/**
2+
**/*.min.js

‎.eslintrc.js

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
module.exports = {
2+
env: {
3+
es6: true
4+
}
5+
}

‎.github/ISSUE_TEMPLATE/bug_report.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: 'Bug: [Brief Description]'
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
## Summary
11+
12+
*What is the issue you are experiencing?*
13+
14+
## Steps
15+
16+
*What are the steps to reproduce this issue?*
17+
1. Go to '...'
18+
2. Click on '....'
19+
3. Scroll down to '....'
20+
4. See error
21+
22+
## Expected Behaviour
23+
24+
*What is the expected behaviour?*
25+
26+
## Screenshots
27+
28+
*If applicable, add screenshots to help explain your problem.*
29+
30+
## Additional context
31+
32+
*Is there anything else that would give context about the problem?*

‎.github/ISSUE_TEMPLATE/feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: 'Feat: [Brief Description]'
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
## Related Issues
11+
12+
*Is your feature request related to a problem? Please describe.*
13+
14+
*A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]*
15+
16+
## Solution
17+
*Describe the solution you'd like*
18+
19+
## Alternatives
20+
*Describe alternatives you've considered*

‎.github/pull_request_template.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Description
2+
3+
*Why are you making this pull request?*
4+
5+
## Related Issues
6+
7+
*Please provide links to any related issues.*

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
.DS_Store
22
node_modules
33
package-lock.json
4+
*/**/*.css
5+
*/**/results

‎.sass-lint.yml

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
files:
22
include:
33
- 'scss/**/*.scss'
4+
- 'test/**/*.scss'
45
syntax:
56
include:
67
- scss

‎CHANGELOG.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Changelog
2+
3+
## 1.0.0
4+
5+
- Add testing
6+
- Move repository
7+
8+
## 0.2.0
9+
10+
- Add documentation
11+
12+
## 0.1.0
13+
14+
- Add initial plugins

‎docs/CODE_OF_CONDUCT.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
26+
* Trolling, insulting/derogatory comments, and personal or political attacks
27+
* Public or private harassment
28+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
29+
* Other conduct which could reasonably be considered inappropriate in a professional setting
30+
31+
## Our Responsibilities
32+
33+
Project maintainers are responsible for clarifying the standards of acceptable
34+
behavior and are expected to take appropriate and fair corrective action in
35+
response to any instances of unacceptable behavior.
36+
37+
Project maintainers have the right and responsibility to remove, edit, or
38+
reject comments, commits, code, wiki edits, issues, and other contributions
39+
that are not aligned to this Code of Conduct, or to ban temporarily or
40+
permanently any contributor for other behaviors that they deem inappropriate,
41+
threatening, offensive, or harmful.
42+
43+
## Scope
44+
45+
This Code of Conduct applies both within project spaces and in public spaces
46+
when an individual is representing the project or its community. Examples of
47+
representing a project or community include using an official project e-mail
48+
address, posting via an official social media account, or acting as an appointed
49+
representative at an online or offline event. Representation of a project may be
50+
further defined and clarified by project maintainers.
51+
52+
## Enforcement
53+
54+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
55+
reported by contacting the project team at [email protected]. All
56+
complaints will be reviewed and investigated and will result in a response that
57+
is deemed necessary and appropriate to the circumstances. The project team is
58+
obligated to maintain confidentiality with regard to the reporter of an incident.
59+
Further details of specific enforcement policies may be posted separately.
60+
61+
Project maintainers who do not follow or enforce the Code of Conduct in good
62+
faith may face temporary or permanent repercussions as determined by other
63+
members of the project's leadership.
64+
65+
## Attribution
66+
67+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
68+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
69+
70+
[homepage]: https://www.contributor-covenant.org
71+
72+
For answers to common questions about this code of conduct, see
73+
https://www.contributor-covenant.org/faq

‎docs/CONTRIBUTING.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Contributing to bootstrap-scss-plugins
2+
3+
Whether you want to add a new plugin or simply report a bug or issue, please have a quick read through these guidelines before contributing.
4+
5+
## Developed with Github
6+
7+
We use github to host code, to track issues and feature requests, as well as accept pull requests. All other forms of communication with maintainers is not considered "official".
8+
9+
## [Github Flow](https://guides.github.com/introduction/flow/index.html) is the Way to Go
10+
11+
All code changes happen through pull requests.
12+
13+
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
14+
15+
1. Fork the repo and create your branch from dev.
16+
2. Link your pull request to any relavent open issues.
17+
3. If you've added or changed plugins, update the documentation.
18+
4. Make sure your code compiles. Write a test if you have to!
19+
5. Make sure your code lints.
20+
6. Issue the pull request!
21+
22+
## Any contribution you make will be under the ISC License
23+
24+
In short, when you submit code changes, your submissions are understood to be under the same ISC License that covers the project. Feel free to contact the maintainers if that's a concern.
25+
26+
## Report bugs using Github's [issues](https://github.com/coldfrontlabs/bootstrap-scss-plugins/issues)
27+
28+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/coldfrontlabs/bootstrap-scss-plugins/issues/new).
29+
30+
## Write bug reports with detail, background, and sample code
31+
32+
**Great Bug Reports** tend to have:
33+
34+
- A quick summary and/or background
35+
- Steps to reproduce
36+
- Be specific!
37+
- Give sample code if you can
38+
- What you expected would happen
39+
- What actually happens
40+
- Notes
41+
- why you think this might be happening
42+
- stuff you tried that didn't work
43+
44+
Everynody loves a thorough bug report!
45+
46+
## Keep Your Code Consistent
47+
48+
- Use the standards provided by the lint file. Run `npm run lint` to be sure.
49+
- Keep mixins in the mixins directory, utilities in the utilities directory, and plugins in the root scss directory.
50+
- Try to use what is provided in "Vanilla" Bootstrap 4
51+
52+
## Commit Guidelines
53+
54+
We use an [Angular style](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits) for commit messages. Please make sure all commits follow this.
55+
56+
If you're unsure of how to format your messages, running `npm run commit` will give you a hand!
57+
58+
## References
59+
60+
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)

‎gulpfile.js

+105
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
// Include gulp.
2+
const gulp = require('gulp');
3+
4+
// Include gulp plugins.
5+
const sass = require('gulp-sass');
6+
const sassLint = require('gulp-sass-lint');
7+
8+
/**
9+
* Runs sass-lint on provided files.
10+
*
11+
* @param {String} source - The path to the source files.
12+
*
13+
* @returns {Object} stream.
14+
*/
15+
function lintSass(source) {
16+
return gulp.src([source])
17+
.pipe(sassLint({
18+
configFile: '.sass-lint.yml'
19+
}))
20+
.pipe(sassLint.format())
21+
.pipe(sassLint.failOnError());
22+
}
23+
24+
function compileSass(source, destination) {
25+
return gulp.src([source])
26+
.pipe(sass().on('error', sass.logError))
27+
.pipe(gulp.dest(destination))
28+
}
29+
30+
/**
31+
* Set linting tests.
32+
*/
33+
34+
// Class test.
35+
const lintClasses = () => lintSass('./test/classes/**/*.scss');
36+
lintClasses.description = 'Lints all class tests.';
37+
38+
// Mixin test.
39+
const lintMixins = () => lintSass('./test/mixins/**/*.scss');
40+
lintMixins.description = 'Lints all mixin tests.';
41+
42+
// Other test.
43+
const lintOther = () => lintSass('./test/other/**/*.scss');
44+
lintOther.description = 'Lints all other tests.';
45+
46+
const lintSource = () => lintSass('./scss/**/*.scss');
47+
lintSource.description = 'Lints all source files.';
48+
49+
/**
50+
* Set compiling tests.
51+
*/
52+
53+
// Class test.
54+
const compileClasses = () => compileSass('./test/classes/**/*.scss', './test/classes/results');
55+
compileClasses.description = 'Compiles all class tests.';
56+
57+
// Mixin test.
58+
const compileMixins = () => compileSass('./test/mixins/**/*.scss', './test/mixins/results');
59+
compileMixins.description = 'Compiles all mixin tests.';
60+
61+
// Other test.
62+
const compileOther = () => compileSass('./test/other/**/*.scss', './test/other/results');
63+
compileOther.description = 'Compiles all other tests.';
64+
65+
function lint (callback) {
66+
gulp.series(
67+
lintClasses,
68+
lintMixins,
69+
lintOther
70+
)(callback);
71+
}
72+
lint.description = 'Lints all tests.';
73+
74+
function compile (callback) {
75+
gulp.series(
76+
compileClasses,
77+
compileMixins,
78+
compileOther
79+
)(callback);
80+
}
81+
compile.description = 'Compiles all tests.';
82+
83+
function defaultTask (callback) {
84+
gulp.series(
85+
lint,
86+
compile
87+
)(callback);
88+
}
89+
defaultTask.description = 'Lints and compiles all tests.';
90+
91+
// Create tasks.
92+
gulp.task('default', defaultTask);
93+
94+
gulp.task(lint);
95+
gulp.task(compile);
96+
97+
gulp.task('lint:classes', lintClasses);
98+
gulp.task('lint:mixins', lintMixins);
99+
gulp.task('lint:other', lintOther);
100+
101+
gulp.task('lint:source', lintSource);
102+
103+
gulp.task('compile:classes', compileClasses);
104+
gulp.task('compile:mixins', compileMixins);
105+
gulp.task('compile:other', compileOther);

‎package.json

+10-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
{
22
"name": "bootstrap-scss-plugins",
3-
"version": "0.2.0",
3+
"version": "1.0.0",
44
"description": "A suite of SCSS plugins used for developing Bootstrap 4 themes and sites.",
5+
"eslintConfig": "./.eslintrc.js",
56
"scripts": {
67
"lint": "sass-lint -v -c .sass-lint.yml",
8+
"eslint": "eslint ./**/*.js",
79
"commit": "npx git cz"
810
},
911
"repository": {
1012
"type": "git",
11-
"url": "git+https://github.com/NickDJM/bootstrap-scss-plugins.git"
13+
"url": "git+https://github.com/coldfrontlabs/bootstrap-scss-plugins.git"
1214
},
1315
"keywords": [
1416
"bootstrap",
@@ -18,15 +20,19 @@
1820
"author": "Nick Milton",
1921
"license": "ISC",
2022
"bugs": {
21-
"url": "https://github.com/NickDJM/bootstrap-scss-plugins/issues"
23+
"url": "https://github.com/coldfrontlabs/bootstrap-scss-plugins/issues"
2224
},
23-
"homepage": "https://github.com/NickDJM/bootstrap-scss-plugins#readme",
25+
"homepage": "https://github.com/coldfrontlabs/bootstrap-scss-plugins#readme",
2426
"dependencies": {
2527
"bootstrap": "^4.2.1"
2628
},
2729
"devDependencies": {
2830
"commitizen": "^3.0.5",
2931
"cz-conventional-changelog": "^2.1.0",
32+
"eslint": "^5.12.1",
33+
"gulp": "^4.0.0",
34+
"gulp-sass": "^4.0.2",
35+
"gulp-sass-lint": "^1.4.0",
3036
"sass-lint": "^1.12.1"
3137
},
3238
"config": {

‎scss/utilities/button-square.scss renamed to ‎scss/utilities/button-squared.scss

File renamed without changes.

‎test/classes/border-widths.scss

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
// ----------
2+
// Compile test for .border-width classes.
3+
// ----------
4+
5+
@import '../../node_modules/bootstrap/scss/bootstrap';
6+
@import '../../scss/border-widths';

‎test/classes/button-rounded.scss

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
// ----------
2+
// Compile test for .btn-rounded class.
3+
// ----------
4+
5+
@import '../../node_modules/bootstrap/scss/bootstrap';
6+
@import '../../scss/button-rounded';

0 commit comments

Comments
 (0)