First Commit

.commitlintrc.yml

@@ -0,0 +1,32 @@
+extends:
+  - '@commitlint/config-conventional'
+
+rules:
+  header-max-length: [1, 'always', 72]
+  type-enum:
+    - 2
+    - always
+    - - chore
+      - ci
+      - feat
+      - fix
+      - docs
+      - style
+      - refactor
+      - perf
+      - test
+      - revert
+
+help: |
+  **Possible types**:
+
+  `chore`:    Change build process, tooling or dependencies.
+  `ci`:       Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
+  `feat`:     Adds a new feature.
+  `fix`:      Solves a bug.
+  `docs`:     Adds or alters documentation.
+  `style`:    Improves formatting, white-space.
+  `refactor`: Rewrites code without feature, performance or bug changes.
+  `perf`:     Improves performance.
+  `test`:     Adds or modifies tests.
+  `revert`:   Changes that reverting other changes

.editorconfig

@@ -0,0 +1,14 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+end_of_line = lf
+max_line_length = 120
+
+[*.md]
+trim_trailing_whitespace = false

.eslintrc

@@ -0,0 +1,4 @@
+{
+  "extends": ["jam3", "plugin:jest/recommended"],
+  "plugins": ["jest"]
+}

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.gitignore

@@ -0,0 +1,20 @@
+## -------- Welcome to the Jam3 gitignore --------
+##
+## Please add your ignores ordered by topics.
+## See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# Global
+.DS_Store
+*.log*
+
+# IDEs
+.vscode
+sketch
+.idea
+
+# Node & NPM
+node_modules
+
+# Tests
+coverage
+

.prettierignore

@@ -0,0 +1,3 @@
+package.json
+package-lock.json
+CHANGELOG.md

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "printWidth": 120
+}

.travis.yml

@@ -0,0 +1,14 @@
+language: node_js
+
+node_js:
+  - '10'
+
+cache:
+  directories:
+    - node_modules
+
+install:
+  - npm install
+
+script:
+  - npm run test-ci

CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### [1.0.1](https://github.com/Jam3/adviser-plugin-lighthouse/compare/v1.0.0...v1.0.1) (2020-01-07)
+
+
+### Bug Fixes
+
+* unknown audits was outputing wrong values ([e975031](https://github.com/Jam3/adviser-plugin-lighthouse/commit/e97503189ee9478ca9ba9e2fe2db3005929d0d19))
+
+## 1.0.0 (2020-01-07)
+
+
+### Bug Fixes
+
+* issues related to custom lighthouse config ([d310039](https://github.com/Jam3/adviser-plugin-lighthouse/commit/d3100399a3c70aed8ff0623b8888686327119a54))
+* multiple reports for scores ([d8d632c](https://github.com/Jam3/adviser-plugin-lighthouse/commit/d8d632c8352537bb3843f93225b5cb0fd92f9034))
+* security vulnerabilities ([3a442eb](https://github.com/Jam3/adviser-plugin-lighthouse/commit/3a442eb50040e28f073ed558043394ba89f1d184))
+* typo ([7a8379b](https://github.com/Jam3/adviser-plugin-lighthouse/commit/7a8379b3ed05824259102b675f8a1c94bcecf2a8))
+
+<a name="0.0.1"></a>
+## 0.0.1
+
+### Features
+
+- A library is born

CODE_OF_CONDUCT.md

@@ -0,0 +1,94 @@
+# Code of Conduct
+
+> A code of conduct is a set of rules outlining the social norms and rules and responsibilities of, or proper practices
+> for, an individual, party or organization
+
+## Summary
+
+This code of conduct is dedicated to providing a harassment-free working environment for all, regardless of gender, sexual orientation, disability, physical appearance, body size, race, or religion. We do not tolerate harassment of any form. All communication should be appropriate for a professional audience including people of many different backgrounds.
+
+Sexual language and imagery are not appropriate for any communication or talks. Be kind and do not insult or put down others. Behave professionally. Remember that harassment and sexist, racist, or exclusionary jokes are not appropriate for this project. Staff violating these rules should be reported to an appropriate line manager.
+
+These are the values to which people in the project should aspire:
+
+- Be friendly and welcoming
+- Be patient
+  - Remember that people have varying communication styles and that not everyone is using their native language. (Meaning and tone can be lost in translation.)
+- Be thoughtful
+  - Productive communication requires effort. Think about how your words will be interpreted.
+  - Remember that sometimes it is best to refrain entirely from commenting.
+- Be respectful
+  - In particular, respect differences of opinion.
+- Be charitable
+  - Interpret the arguments of others in good faith, do not seek to disagree.
+  - When we do disagree, try to understand why.
+- Avoid destructive behaviour:
+  - Derailing: stay on topic; if you want to talk about something else, start a new conversation.
+  - Unconstructive criticism: don't merely decry the current state of affairs; offer—or at least solicit—suggestions as to how things may be improved.
+  - Snarking (pithy, unproductive, sniping comments)
+  - Discussing potentially offensive or sensitive issues; this all too often leads to unnecessary conflict.
+  - Microaggressions: brief and commonplace verbal, behavioural and environmental indignities that communicate hostile, derogatory or negative slights and insults to a person or group.
+
+People are complicated. You should expect to be misunderstood and to misunderstand others; when this inevitably occurs, resist the urge to be defensive or assign blame. Try not to take offence where no offence was intended. Give people the benefit of the doubt. Even if the intent was to provoke, do not rise to it. It is the responsibility of all parties to de-escalate conflict when it arises.
+
+## Reporting an incident
+
+Incidents that violate the Code of Conduct are extremely damaging to the project, and they will not be tolerated. The silver lining is that, in many cases, these incidents present a chance for the offenders, and the teams at large, to grow, learn, and become better.
+
+> The following should be handled by a line manager who has been informed of the incident
+
+Try to get as much of the incident in written form. The important information to gather include the following:
+
+- Name and the team of the participant doing the harassing
+- The location in which the incident occurred
+- The behaviour that was in violation
+- The approximate time of the behaviour
+- The circumstances surrounding the incident
+- Other people involved in the incident
+
+Depending on the severity/details of the incident, please follow these guidelines:
+
+- If there is any general threat to staff or any other doubts, summon security or police
+- Offer the victim a private place to sit
+- Ask "is there a friend or trusted person whom you would like to be with you?" (if so, arrange for someone to fetch this person)
+- Ask them "how can I help?"
+- Provide them with your list of emergency contacts if they need help later
+- If everyone is presently physically safe, involve the police or security only at a victim's request
+
+There are also some guidelines as to what not to do as an initial response:
+
+- Do not overtly invite them to withdraw the complaint or mention that withdrawal is OK. This suggests that you want them to do so, and is therefore coercive. "If you're OK with pursuing the complaint" suggests that you are by default pursuing it and is not coercive.
+- Do not ask for their advice on how to deal with the complaint. This is a staff responsibility.
+- Do not offer them input into penalties. This is the staff's responsibility.
+
+The line manager who is handling the reported offence should find out the following:
+
+- What happened?
+- Are we doing anything about it?
+- Who is doing those things?
+- When are they doing them?
+
+After the above has been identified and discussed, have an appropriate line manager communicate with the alleged harasser. Make sure to inform them of what has been reported about them.
+
+Allow the alleged harasser to give their side of the story. After this point, if the report stands, let the alleged harasser know what actions will be taken against them.
+
+Some things for the staff to consider when dealing with Code of Conduct offenders:
+
+- Warning the harasser to cease their behaviour and that any further reports will result in sanctions
+- Requiring that the harasser avoid any interaction with, and physical proximity to, their victim until a resolution or course of action has been decided upon
+- Requiring that the harasser not volunteer for future events your organization runs (either indefinitely or for a certain period)
+- Depending on the severity/details of the incident, requiring that the harasser immediately be sent home
+- Depending on the severity/details of the incident, removing a harasser from membership of relevant projects
+- Depending on the severity/details of the incident, publishing an account of the harassment and calling for the resignation of the harasser from their responsibilities (usually pursued by people without formal authority: may be called for if the harasser is a team leader, or refuses to stand aside from the conflict of interest)
+
+Give accused staff members a place to appeal to if there is one, but in the meantime, the report stands. Keep in mind that it is not a good idea to encourage an apology from the harasser.
+
+It is essential how we deal with the incident publicly. Our policy is to make sure that everyone aware of the initial incident is also made aware that it is not according to policy and that official action has been taken - while still respecting the privacy of individual staff members. When speaking to individuals (those who are aware of the incident, but were not involved with the incident) about the incident, it is a good idea to keep the details out.
+
+Depending on the incident, the head of the responsible department, or designate, may decide to make one or more public announcements. If necessary, this will be done with a short announcement either during the plenary and/or through other channels. No one other than the head of the responsible department or someone delegated authority from them should make any announcements. No personal information about either party will be disclosed as part of this process.
+
+If some members of staff were angered by the incident, it is best to apologize to them that the incident occurred, to begin with. If there are residual hard feelings, suggest to them to write an email to the responsible head of the department. It will be dealt with accordingly.
+
+## Attribution
+
+This Code of Conduct was adapted from both [Golang](https://golang.org/conduct) a the [Golang UK Conference](http://golanguk.com/conduct/).

CONTRIBUTING.md

@@ -0,0 +1,41 @@
+# Contributing to this library
+
+Are you thinking about getting involved with the library? Great!, there are a few things you need to know.
+
+## Code of Conduct
+
+We have adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
+
+## Branching
+
+Our `master` branch has the latest code, with tests passing after every PR is merged. However, if you want to use the latest stable version is recommended to download the latest release.
+
+### Branching name convention
+
+`[topic]/[natural-name]`
+
+Where [topic] are the same types requires by [commitlint](.commitlintrc.yml)
+
+## Semantic Versioning
+
+We follow [semantic versioning](http://semver.org/). We release patch versions for bugfixes, minor versions for new features, and major versions for any breaking changes. When we make breaking changes, we also introduce deprecation warnings in a minor version so that our users learn about the upcoming changes and migrate their code in advance.
+
+We tag every pull request with a label marking whether the change should go in the next patch, minor, or a major version.
+
+Every significant change is documented in the [changelog file](CHANGELOG.md).
+
+## Bugs
+
+We are using GitHub Issues for our public bugs. Before creating a new issue, try to make sure your problem doesn’t already exist.
+
+We are using a template for our issues, using this template will reduce the time of understanding the issue and creating a solution.
+
+## Pull Requests
+
+Pull Requests are welcome, please follow our template.
+
+You should always create Pull Request and never merge directly to `master`, and the `master` branch will be protected by default.
+
+## Coding Style Guides
+
+To ensure following the same code style guidelines we are using in the repository Prettier and ESLint. By default, the repository is set up to avoid pushing if the coding rules are not being followed.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Jam3
+
+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.