Skip to content

Commit b8167f8

Browse files
MichMichMichMich
authored
Merge pull request #448 from MichMich/develop
Release 2.0.5
2 parents d1f5118 + c916472 commit b8167f8

File tree

26 files changed

+345
-171
lines changed

26 files changed

+345
-171
lines changed

‎.eslintignore‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
vendor/
22
!/vendor/vendor.js
3-
/modules/**
43
!/modules/default/**
54
!/modules/node_helper
65
!/modules/node_helper/**

‎.github/CONTRIBUTING.md‎

Lines changed: 19 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -3,57 +3,47 @@ Contribution Policy for MagicMirror²
33

44
Thanks for contributing to MagicMirror²!
55

6-
We hold our code to standard, and these standards are documented below.
6+
We hold our code to standard, and these standards are documented below.
77

8-
First, before you run the linters, you will need to install them all **and** install the development dependencies:
8+
If you wish to run both linters, use `grunt` without any arguments.
99

10-
```bash
11-
(sudo) npm install -g jscs stylelint html-validator-cli
12-
npm install
13-
```
10+
### JavaScript: Run ESLint
1411

15-
### JavaScript: Run JSCS
12+
We use [ESLint](http://eslint.org) on our JavaScript files.
1613

17-
We use [JSCS](http://jscs.info) on our JavaScript files.
14+
Our ESLint configuration is in our .eslintrc.json and .eslintignore files.
1815

19-
Our JSCS configuration is in our .jscsrc file.
20-
21-
To run JSCS, use `npm run jscs`.
16+
To run ESLint, use `grunt eslint`.
2217

2318
### CSS: Run StyleLint
2419

2520
We use [StyleLint](http://stylelint.io) to lint our CSS. Our configuration is in our .stylelintrc file.
2621

27-
To run StyleLint, use `npm run stylelint`.
28-
29-
### HTML: Run HTML Validator
30-
31-
We use [NU Validator](https://validator.w3.org/nu) to validate our HTML. The configuration is in the command in the package.json file.
32-
33-
To run HTML Validator, use `npm run htmlvalidator`.
22+
To run StyleLint, use `grunt stylelint`.
3423

35-
## Submitting Issues
24+
### Submitting Issues
3625

3726
Please only submit reproducible issues.
3827

39-
If you're not sure if it's a real bug or if it's just you, please open a topic on the forum: https://forum.magicmirror.builders/category/15/bug-hunt - Problems installing or configuring your MagicMirror? Check out: https://forum.magicmirror.builders/category/10/troubleshooting
28+
If you're not sure if it's a real bug or if it's just you, please open a topic on the forum: [https://forum.magicmirror.builders/category/15/bug-hunt](https://forum.magicmirror.builders/category/15/bug-hunt)
29+
Problems installing or configuring your MagicMirror? Check out: [https://forum.magicmirror.builders/category/10/troubleshooting](https://forum.magicmirror.builders/category/10/troubleshooting)
4030

4131
When submitting a new issue, please supply the following information:
4232

43-
**Platform** [ Raspberry Pi 2/3, Windows, Mac OS X, Linux, Etc ... ]:
33+
**Platform**: Place your platform here... give us your web browser/Electron version *and* your hardware (Raspberry Pi 2/3, Windows, Mac, Linux, System V UNIX).
4434

45-
**Node Version** [ 0.12.13 or later ]:
35+
**Node Version**: Make sure it's version 0.12.13 or later.
4636

47-
**MagicMirror Version** [ V1 / V2-Beta ]:
37+
**MagicMirror Version**: Now that the versions have split, tell us if you are using the PHP version (v1) or the newer JavaScript version (v2).
4838

49-
**Description:** Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.
39+
**Description**: Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.
5040

51-
**Steps to Reproduce:** List the step by step process to reproduce the issue.
41+
**Steps to Reproduce**: List the step by step process to reproduce the issue.
5242

53-
**Expected Results:** Describe what you expected to see.
43+
**Expected Results**: Describe what you expected to see.
5444

55-
**Actual Results:** Describe what you actually saw.
45+
**Actual Results**: Describe what you actually saw.
5646

57-
**Configuration:** What does the used config.js file look like? (Don't forget to remove any sensitive information.)
47+
**Configuration**: What does the used config.js file look like? Don't forget to remove any sensitive information!
5848

59-
**Additional Notes:** Provide any other relevant notes not previously mentioned (optional)
49+
**Additional Notes**: Provide any other relevant notes not previously mentioned. This is optional.

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
11
Please only submit reproducible issues.
22

3-
If you're not sure if it's a real bug or if it's just you, please open a topic on the forum: https://forum.magicmirror.builders/category/15/bug-hunt - Problems installing or configuring your MagicMirror? Check out: https://forum.magicmirror.builders/category/10/troubleshooting
3+
If you're not sure if it's a real bug or if it's just you, please open a topic on the forum: [https://forum.magicmirror.builders/category/15/bug-hunt](https://forum.magicmirror.builders/category/15/bug-hunt)
4+
Problems installing or configuring your MagicMirror? Check out: [https://forum.magicmirror.builders/category/10/troubleshooting](https://forum.magicmirror.builders/category/10/troubleshooting)
45

5-
**Platform** [ Raspberry Pi 2/3, Windows, Mac OS X, Linux, Etc ... ]:
6+
When submitting a new issue, please supply the following information:
67

7-
**Node Version** [ 0.12.13 or later ]:
8+
**Platform**: Place your platform here... give us your web browser/Electron version *and* your hardware (Raspberry Pi 2/3, Windows, Mac, Linux, System V UNIX).
89

9-
**MagicMirror Version** [ V1 / V2-Beta ]:
10+
**Node Version**: Make sure it's version 0.12.13 or later.
1011

11-
**Description:** Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.
12+
**MagicMirror Version**: Now that the versions have split, tell us if you are using the PHP version (v1) or the newer JavaScript version (v2).
1213

13-
**Steps to Reproduce:** List the step by step process to reproduce the issue.
14+
**Description**: Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.
1415

15-
**Expected Results:** Describe what you expected to see.
16+
**Steps to Reproduce**: List the step by step process to reproduce the issue.
1617

17-
**Actual Results:** Describe what you actually saw.
18+
**Expected Results**: Describe what you expected to see.
1819

19-
**Configuration:** What does the used config.js file look like? (Don't forget to remove any sensitive information.)
20+
**Actual Results**: Describe what you actually saw.
2021

21-
**Additional Notes:** Provide any other relevant notes not previously mentioned (optional)
22+
**Configuration**: What does the used config.js file look like? Don't forget to remove any sensitive information!
23+
24+
**Additional Notes**: Provide any other relevant notes not previously mentioned. This is optional.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
> Please send your PR's the develop branch.
2-
> Don't forget to add the change to changelog.md.
1+
> Please send your pull requests the develop branch.
2+
> Don't forget to add the change to CHANGELOG.md.
33
4-
* Does the pull request solve a **related** issue? [yes | no]
4+
* Does the pull request solve a **related** issue?
55
* If so, can you reference the issue?
6-
* What does the pull request accomplish? (please list)
6+
* What does the pull request accomplish? Use a list if needed.
77
* If it includes major visual changes please add screenshots.
8-
9-

‎.stylelintrc‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
22
"extends": "stylelint-config-standard",
3-
"font-family-name-quotes": "double-where-recommended"
4-
}
3+
"font-family-name-quotes": "double-where-recommended",
4+
"block-no-empty": false
5+
}

‎CHANGELOG.md‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,30 @@
22
All notable changes to this project will be documented in this file.
33
This project adheres to [Semantic Versioning](http://semver.org/).
44

5+
## [2.0.5] - 2016-09-20
6+
7+
### Added
8+
- Added ability to remove tags from the beginning or end of newsfeed items in 'newsfeed.js'.
9+
- Added ability to define "the day after tomorrow" for calendar events (Definition for German and Dutch already included).
10+
- Added CII Badge (we are compliant with the CII Best Practices)
11+
- Add support for doing http basic auth when loading calendars
12+
- Add the abilty to turn off and on the date display in the Clock Module
13+
14+
### Fixed
15+
- Fix typo in installer.
16+
- Add message to unsupported Pi error to mention that Pi Zeros must use server only mode, as ARMv6 is unsupported. Closes #374.
17+
- Fix API url for weather API.
18+
19+
### Updated
20+
- Force fullscreen when kioskmode is active.
21+
- Update the .github templates and information with more modern information.
22+
- Update the Gruntfile with a more functional StyleLint implementation.
23+
524
## [2.0.4] - 2016-08-07
625

726
### Added
827
- Brazilian Portuguese Translation.
9-
- Option to enable Kios mode.
28+
- Option to enable Kiosk mode.
1029
- Added ability to start the app with Dev Tools.
1130
- Added ability to turn off the date display in `clock.js` when in analog mode.
1231
- Greek Translation
@@ -71,4 +90,4 @@ It includes (but is not limited to) the following features:
7190

7291
## [1.0.0] - 2014-02-16
7392
### Initial release of MagicMirror.
74-
This was part of the blogpost: http://michaelteeuw.nl/post/83916869600/magic-mirror-part-vi-production-of-the
93+
This was part of the blogpost: [http://michaelteeuw.nl/post/83916869600/magic-mirror-part-vi-production-of-the](http://michaelteeuw.nl/post/83916869600/magic-mirror-part-vi-production-of-the)

‎Gruntfile.js‎

Lines changed: 49 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,60 @@ module.exports = function(grunt) {
88
},
99
target: ["js/*.js", "modules/default/*.js", "serveronly/*.js", "*.js"]
1010
},
11-
postcss: {
12-
lint: {
11+
stylelint: {
12+
simple: {
1313
options: {
14-
processors: [
15-
require("stylelint")({"extends": "stylelint-config-standard", "font-family-name-quotes": "double-where-recommended"}),
16-
require("postcss-reporter")({ clearMessages: true })
17-
]
14+
configFile: ".stylelintrc"
1815
},
19-
dist: {
20-
src: "**/**/**/**/**/**/**/**.css"
16+
src: ["css/main.css", "modules/default/calendar/calendar.css", "modules/default/clock/clock_styles.css", "modules/default/currentweather/currentweather.css", "modules/default/weatherforcast/weatherforcast.css"]
17+
}
18+
},
19+
jsonlint: {
20+
main: {
21+
src: ["package.json", ".eslintrc.json", ".stylelint"],
22+
options: {
23+
reporter: "jshint"
2124
}
2225
}
26+
},
27+
markdownlint: {
28+
all: {
29+
options: {
30+
config: {
31+
"default": true,
32+
"line-length": false,
33+
"blanks-around-headers": false,
34+
"no-duplicate-header": false,
35+
"no-inline-html": false,
36+
"MD010": false,
37+
"MD001": false,
38+
"MD031": false,
39+
"MD040": false,
40+
"MD002": false,
41+
"MD029": false,
42+
"MD041": false,
43+
"MD032": false,
44+
"MD036": false,
45+
"MD037": false,
46+
"MD009": false,
47+
"MD018": false,
48+
"MD012": false,
49+
"MD026": false,
50+
"MD036": false,
51+
"MD038": false
52+
}
53+
},
54+
src: ["README.md", "CHANGELOG.md", "LICENSE.md", "modules/README.md", "modules/default/**/*.md", "!modules/default/calendar/vendor/ical.js/readme.md"]
55+
}
56+
},
57+
yamllint: {
58+
all: [".travis.yml"]
2359
}
2460
});
2561
grunt.loadNpmTasks("grunt-eslint");
26-
grunt.loadNpmTasks("grunt-postcss");
27-
grunt.registerTask("default", ["eslint", "postcss:lint"]);
62+
grunt.loadNpmTasks("grunt-stylelint");
63+
grunt.loadNpmTasks("grunt-jsonlint");
64+
grunt.loadNpmTasks("grunt-yamllint");
65+
grunt.loadNpmTasks("grunt-markdownlint");
66+
grunt.registerTask("default", ["eslint", "stylelint", "jsonlint", "markdownlint", "yamllint"]);
2867
};

‎README.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<p align="center">
44
<a href="https://david-dm.org/MichMich/MagicMirror"><img src="https://david-dm.org/MichMich/MagicMirror.svg" alt="Dependency Status"></a>
55
<a href="https://david-dm.org/MichMich/MagicMirror#info=devDependencies"><img src="https://david-dm.org/MichMich/MagicMirror/dev-status.svg" alt="devDependency Status"></a>
6-
<a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-v5.10.1-brightgreen.svg" alt="Node Version"></a>
6+
<a href="https://bestpractices.coreinfrastructure.org/projects/347"><img src="https://bestpractices.coreinfrastructure.org/projects/347/badge"></a>
77
<a href="http://choosealicense.com/licenses/mit"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
88
<a href="https://travis-ci.org/MichMich/MagicMirror"><img src="https://travis-ci.org/MichMich/MagicMirror.svg" alt="Travis"></a>
99
<a href="https://snyk.io/test/github/MichMich/MagicMirror"><img src="https://snyk.io/test/github/MichMich/MagicMirror/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/MichMich/MagicMirror" style="max-width:100%;"></a>
@@ -24,17 +24,17 @@ MagicMirror² focuses on a modular plugin system and uses [Electron](http://elec
2424

2525
## Usage
2626

27-
#### Raspberry Pi Support
27+
### Raspberry Pi Support
2828
Electron, the app wrapper around MagicMirror², only supports the Raspberry Pi 2 & 3. The Raspberry Pi 1 is currently **not** supported. If you want to run this on a Raspberry Pi 1, use the [server only](#server-only) feature and setup a fullscreen browser yourself.
2929

30-
#### Automatic Installer (Raspberry Pi Only!)
30+
### Automatic Installer (Raspberry Pi Only!)
3131

3232
Execute the following command on your Raspberry Pi to install MagicMirror²:
3333
````
3434
curl -sL https://raw.githubusercontent.com/MichMich/MagicMirror/master/installers/raspberry.sh | bash
3535
````
3636

37-
#### Manual Installation
37+
### Manual Installation
3838

3939
1. Download and install the latest Node.js version.
4040
2. Clone the repository and check out the beta branch: `git clone https://github.com/MichMich/MagicMirror`
@@ -45,23 +45,23 @@ curl -sL https://raw.githubusercontent.com/MichMich/MagicMirror/master/installer
4545

4646
**Note:** if you want to debug on Raspberry Pi you can use `npm start dev` which will start the MagicMirror app with Dev Tools enabled.
4747

48-
#### Server Only
48+
### Server Only
4949

5050
In some cases, you want to start the application without an actual app window. In this case, execute the following command from the MagicMirror folder: `node serveronly`. This will start the server, after which you can open the application in your browser of choice.
5151

52-
#### Raspberry Configuration & Auto Start.
52+
### Raspberry Configuration & Auto Start.
5353

5454
The following wiki links are helpful in the configuration of your MagicMirror² operating system:
5555
- [Configuring the Raspberry Pi](https://github.com/MichMich/MagicMirror/wiki/Configuring-the-Raspberry-Pi)
5656
- [Auto Starting MagicMirror](https://github.com/MichMich/MagicMirror/wiki/Auto-Starting-MagicMirror)
5757

58-
#### Updating you MagicMirror²
58+
### Updating your MagicMirror²
5959

6060
If you want to update your MagicMirror² to the latest version, use your terminal to go to your Magic Mirror folder and type the following command:
6161

62-
````
62+
```bash
6363
git pull
64-
````
64+
```
6565

6666
If you changed nothing more than the config or the modules, this should work without any problems.
6767
Type `git status` to see your changes, if there are any, you can reset them with `git reset --hard`. After that, git pull should be possible.

‎css/main.css‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
html {
22
cursor: none;
3-
overflow:hidden;
3+
overflow: hidden;
44
}
55

6-
::-webkit-scrollbar {
7-
display: none;
6+
::-webkit-scrollbar {
7+
display: none;
88
}
99

1010
body {

‎installers/raspberry.sh‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ ARM=$(uname -m)
2828
if [ "$ARM" != "armv7l" ]; then
2929
echo -e "\e[91mSorry, your Raspberry Pi is not supported."
3030
echo -e "\e[91mPlease run MagicMirror on a Raspberry Pi 2 or 3."
31+
echo -e "\e[91mIf this is a Pi Zero, you are in the same boat as the original Raspberry Pi. You must run in server only mode."
3132
exit;
3233
fi
3334

@@ -68,7 +69,7 @@ else
6869
NODE_INSTALL=true
6970
fi
7071

71-
# Install or upgare node if nessecery.
72+
# Install or upgrade node if necessary.
7273
if $NODE_INSTALL; then
7374

7475
echo -e "\e[96mInstalling Node.js ...\e[90m"

0 commit comments

Comments
 (0)