Skip to content

Commit

Permalink
Update: Added everything
Browse files Browse the repository at this point in the history
  • Loading branch information
Berkmann18 committed Oct 23, 2018
1 parent e142243 commit be44a89
Show file tree
Hide file tree
Showing 17 changed files with 9,669 additions and 1 deletion.
38 changes: 38 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
module.exports = {
"env": {
"browser": true,
"es6": true,
"node": true
},
"plugins": [
"security"
],
"extends": [
"plugin:security/recommended"
],
"rules": {
"indent": [
"error",
2
],
"linebreak-style": [
"error"
],
"no-console": "off",
"no-extra-semi": "off",
"prefer-const": "off",
"quotes": [
"error",
"single"
],
"no-trailing-spaces": [
"error"
],
"symbol-description": [
"warn"
]
},
"parserOptions": {
"sourceType": "module"
}
};
13 changes: 13 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Contributor Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.

Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](https://www.contributor-covenant.org/version/1/0/0/code-of-conduct.html)
21 changes: 21 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Contribution guide

1. Make sure you always pull the latest changes from the repo and `rebase` from the
`master` branch whenever it's necessary.
2. Always work on the `dev` branch or dedicated branches (e.g.: for features).
3. Don't modify generated files in `/doc` and in `/dist`.
4. Squash commits in branches to reduce the chain whenever its possible.
5. Always **test** your code using `npm test`.
6. If you add new code, ensure that it's covered by test cases.
7. If you fix an issue, mention `fix #x` (where x is the issue number).
8. Ensure that you use the appropriate code style (that can be checked
with `npm run lint`).
9. Make sure you follow the [ESLint commit convention](https://eslint.org/docs/developer-guide/contributing/pull-requests#step2)

## Project structure
- **`charts`**: contains SVG flowcharts.
- **`config`**: contains some configurations.
- **`doc`**: contains the documentation.
- **`examples`**: contains some example files that can be used for testing purposes.
- **`src`**: contains source files.
- **`test`**: contains all tests, unit tests are written using Jest and E2E are written with Nightwatch.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---

name: Bug report
about: Create a report to help us improve
---

## Expected behaviour


## Actual behaviour


## How to reproduce

<!-- Steps to reproduce the bug -->

## Possible solution(s)
<!--How do you think, the issue should be solved ? -->

## Environment
- Version:
- OS(s):
- Browser(s):
- Node version: 10.7.0
- NPM version: 6.2.0

## Link or repo

<!-- Paste a REPL/CodePen/LogRocket or minimal Github repo link -->
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---

name: Feature request
about: Submit a proposal for a feature request
---

## Proposal


## Motivation


## Use cases and examples
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/QUESTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---

name: Question
about: Need support or a question in mind?
---
24 changes: 24 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## Checklist

- [ ] The PR follows the [guidelines](CONTRIBUTING.md)
- [ ] Passes all the tests (including added/updated ones)
- [ ] Contains a valid documentation
- [ ] It's not a duplicate from another PR

## Changes
This PR implements:
- [ ] Bugfix
- [ ] Feature
- [ ] Refactoring
- [ ] Documentation/wiki/tutorial update
- [ ] Code style update
- [ ] Build related change
- [ ] Other, please specify:

## Details
What does this PR implements exactly?

What issues does this resolve?
<!-- Fixes #1, Closes #2 -->

If it completes one ore more tasks (listed in [TODO](TODO.md)), which ones are those?
45 changes: 45 additions & 0 deletions .github/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
## Configuration for request-info - https://github.com/behaviorbot/request-info

# *Required* Comment to reply with
#requestInfoReplyComment: >
# We would appreciate it if you could provide us with more info about this issue/PR!

# *OPTIONAL* default titles to check against for lack of descriptiveness
# MUST BE ALL LOWERCASE
requestInfoDefaultTitles:
- update readme.md
- updates
- error
- issue

# *OPTIONAL* Label to be added to Issues and Pull Requests with insufficient information given
requestInfoLabelToAdd: needs-more-info

## Configuration for todo - https://github.com/jasonetco/todo
todo:
keyword: "@makeAnIssue"

# Configuration for welcome - https://github.com/behaviorbot/welcome
# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome

# Comment to be posted to on first time issues
newIssueWelcomeComment: >
Thanks for opening your first issue here! Be sure to follow the issue templates :simple_smile: !
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome

# Comment to be posted to on PRs from first time contributors in your repository
newPRWelcomeComment: >
Thanks for opening this PR (Pull Request)! Please check out our [contributing guidelines](./github/CONTRIBUTING.md).
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge

# Comment to be posted to on pull requests merged by a first time user
firstPRMergeComment: >
:tada: Congrats on merging your first PR! We are proud of you!
requestInfoReplyComment: >
We would appreciate it if you could provide us with more info about this issue/PR!
#requestInfoLabelToAdd: request-info
6 changes: 6 additions & 0 deletions .github/eslint-disable-bot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Change this to set the number of comments the watcher should comment on a given PR.
commentLimit: 20
# The message the bot will post on any lines containing a eslint disable comment.
commentMessage: Please don't disable eslint rules :pray:
# A optional regular expression that will match against the branch name and not comment on it if it matches.
skipBranchMatching: null
134 changes: 134 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
# User-specific stuff:
.idea
.idea_modules/

## File-based project format:
*.iws

## Plugin-specific files:

# IntelliJ
/out/

# Crashlytics plugin (for Android Studio and IntelliJ)
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties
fabric.properties
### SublimeText template
# cache files for sublime text
*.tmlanguage.cache
*.tmPreferences.cache
*.stTheme.cache

# workspace files are user-specific
*.sublime-workspace

# project files should be checked into the repository, unless a significant
# proportion of contributors will probably not be using SublimeText
# *.sublime-project

# sftp configuration file
sftp-config.json

# Package control specific files
Package Control.last-run
Package Control.ca-list
Package Control.ca-bundle
Package Control.system-ca-bundle
Package Control.cache/
Package Control.ca-certs/
bh_unicode_properties.cache

# Sublime-github package stores a github token in this file
# https://packagecontrol.io/packages/sublime-github
GitHub.sublime-settings
### Dropbox template
# Dropbox settings and caches
.dropbox
.dropbox.attr
.dropbox.cache
### Node template
# Logs
logs
*.log
npm-debug.log*

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# node-waf configuration
.lock-wscript

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules
jspm_packages

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

### Linux template
*~

# temporary files which can be created if a process still has a handle open of a deleted file
.fuse_hidden*

# KDE directory preferences
.directory

# Linux trash folder which might appear on any partition or disk
.Trash-*

# .nfs files are created when an open file is removed but is still being accessed
.nfs*
### Windows template
# Windows image file caches
Thumbs.db
ehthumbs.db

# Folder config file
Desktop.ini

# Recycle Bin used on file shares
$RECYCLE.BIN/

# Windows Installer files
*.cab
*.msi
*.msm
*.msp

# Windows shortcuts
*.lnk

.vscode
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2018 Maximilian Berkmann

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,19 @@
# nclr
Mini NPM package with coloured log functions

[![NPM](https://nodei.co/npm/nclr.png)](https://nodei.co/npm/nclr/)
[![GitHub contributors](https://img.shields.io/github/contributors/Berkmann18/nclr.svg)](https://github.com/Berkmann18/nclr/graphs/contributors)
[![Github search hit counter](https://img.shields.io/github/search/Berkmann18/nclr/goto.svg)](https://github.com/Berkmann18/nclr/graphs/traffic)
[![dev dependencies Status](https://david-dm.org/dev/Berkmann18/nclr/status.svg)](https://david-dm.org/dev/Berkmann18/nclr)
[![Build Status](https://travis-ci.org/Berkmann18/nclr.svg?branch=master)](https://travis-ci.org/Berkmann18/nclr)
[![BCH compliance](https://bettercodehub.com/edge/badge/Berkmann18/nclr?branch=master)](https://bettercodehub.com/)
[![codecov.io Code Coverage](https://img.shields.io/codecov/c/github/Berkmann18/nclr.svg?maxAge=2592000)](https://codecov.io/github/Berkmann18/nclr?branch=master)
[![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://github.com/facebook/jest)
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/Berkmann18/nclr/issues)
[![GitHub top language](https://img.shields.io/github/languages/top/Berkmann18/nclr.svg)](https://github.com/Berkmann18/nclr)
[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/Berkmann18/nclr.svg)](https://github.com/Berkmann18/nclr)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

Mini NPM package with coloured log functions.

# Contributions
Please refer to [that](.github/CONTRIBUTING.md).
Loading

0 comments on commit be44a89

Please sign in to comment.