Merge eacc47d into 90fc2bf

.prettierignore

@@ -0,0 +1,2 @@
+lib
+coverage

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true
+}

.travis.yml

@@ -1,10 +1,10 @@
 language: node_js
 node_js:
-    - "8"
-    - "9"
-    - "10"
-    - "11"
-    - "12"
-    - "13"
+  - '8'
+  - '9'
+  - '10'
+  - '11'
+  - '12'
+  - '13'
 after_success:
-    - npm run coveralls
+  - npm run coveralls

CHANGELOG.md

@@ -2,8 +2,12 @@
 
 ## Version 2.3.0
 
+- Added Prettier code style
+- Deleted .npmignore and switched to `package.json` files field
+- Added [CONTRIBUTING](./CONTRIBUTING.md) and [CODE_OF_CONDUCT](./CODE_OF_CONDUCT.md) docs
 - Switched to `moo-color` for color parsing
 - Added contributors to markdown document
+  - New Contributor [@evanoc0](https://github.com/evanoc0)
 
 ## Version 2.2.0
 

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing
+
+The following is a set of guidelines for contributing to jest-canvas-mock. These are mostly guidelines, not rules. Use your best judgement, and feel free to proposse changes to this document in a pull request.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+
+## Filing Issues
+
+Bugs and enhancement suggestions are tracked as GitHub issues.
+
+#### How Do I Submit A (Good) Bug Report?
+
+After you've determined which repository your bug is related to and that the issue is still present in the latest version of the master branch, create an issue on that repository and provide the following information:
+
+- Use a **clear and descriptive title** for the issue to identify the problem.
+- Explain which **behavior you expected** to see instead and why.
+- Describe the exact **steps to reproduce the problem** in as many details as necessary.
+- When providing code samples, please use [code blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks/).
+
+#### How Do I Submit A (Good) Enhancement Suggestion?
+
+Instructions are similar to those for bug reports. Please provide the following information:
+
+- Use a **clear and descriptive title** for the issue to identify the suggestion.
+- Provide a **description of the suggested enhancement** in as many details as necessary.
+- When providing code samples, please use [code blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks/).
+
+## Submitting Pull Requests
+
+Instructions are similar to those for bug reports. Please provide the following information:
+
+- Use a **clear and descriptive title** for the pull request.
+- Provide a **description of the suggested changes** in as many details as necessary.
+- **Document your new code** where necessary.
+- Please **refrain from refactoring (unrelated code)** as it makes your pull request easier to review.
+- **Create tests for your new code** where necessary. For creating or updating tests, please see the [Test Instructions](./__tests__).
+
+Before submitting your pull request, please make sure that the following conditions are met:
+
+- Your new code **adheres to the code style** through running `npm run prettier`.
+- Your new code **passes all existing and new tests** through running `npm test`.
+- You appended yourself to the **list of contributors** in the [README](./README.md) file.

README.md

@@ -82,23 +82,23 @@ The function will do `Number` type coercion and verify the inputs exactly like t
 this is valid input.
 
 ```ts
-expect(() => ctx.arc("10", "10", "20", "0", "6.14")).not.toThrow();
+expect(() => ctx.arc('10', '10', '20', '0', '6.14')).not.toThrow();
 ```
 
 Another part of the strategy is to validate input types. When using the
 `CanvasRenderingContext2D#fill` function, if you pass it an invalid `fillRule` it will throw a
 `TypeError` just like the browser does.
 
 ```ts
-expect(() => ctx.fill("invalid!")).toThrow(TypeError);
-expect(() => ctx.fill(new Path2D(), "invalid!")).toThrow(TypeError);
+expect(() => ctx.fill('invalid!')).toThrow(TypeError);
+expect(() => ctx.fill(new Path2D(), 'invalid!')).toThrow(TypeError);
 ```
 
 We try to follow the ECMAScript specification as closely as possible.
 
 ## Snapshots
 
-There are multiple ways to validate canvas state using snapshots. There are currently three  methods
+There are multiple ways to validate canvas state using snapshots. There are currently three methods
 attached to the `CanvasRenderingContext2D` class. The first way to use this feature is by using the
 `__getEvents` method.
 
@@ -175,10 +175,10 @@ canvas.toDataURL.mockReturnValueOnce(
 
 ## Contributors
 
-* [@hustcc](https://github.com/hustcc)
-* [@jtenner](https://github.com/jtenner)
-* [@evanoc0](https://github.com/evanoc0)
+- [@hustcc](https://github.com/hustcc)
+- [@jtenner](https://github.com/jtenner)
+- [@evanoc0](https://github.com/evanoc0)
 
 ## License
 
-MIT@[hustcc](https://github.com/hustcc).
+MIT@[hustcc](https://github.com/hustcc).

__tests__/classes/CanvasGradient.js

@@ -9,7 +9,7 @@ beforeEach(() => {
 describe('CanvasGradient', () => {
   test('CanvasGradient', () => {
     expect(grd).toBeDefined();
-    grd.addColorStop(1.0, "blue");
+    grd.addColorStop(1.0, 'blue');
     expect(grd.addColorStop).toBeCalledWith(1.0, 'blue');
 
     const grd2 = ctx.createLinearGradient(2, 3, 4, 5);
@@ -22,7 +22,7 @@ describe('CanvasGradient', () => {
     expect(grd1.addColorStop).not.toBe(grd2.addColorStop);
   });
 
-  [Infinity, NaN, -Infinity].forEach(value => {
+  [Infinity, NaN, -Infinity].forEach((value) => {
     test('CanvasGradient should throw if offset is ' + value, () => {
       expect(() => {
         var grd = ctx.createLinearGradient(1, 2, 3, 4);

__tests__/classes/CanvasPattern.js

@@ -11,7 +11,6 @@ beforeEach(() => {
 });
 
 describe('CanvasPattern', () => {
-
   test('CanvasPattern', () => {
     const ptrn = ctx.createPattern(img, 'no-repeat');
     expect(ptrn).toBeDefined();

__tests__/classes/CanvasRenderingContext2D.__clearDrawCalls.js

@@ -1,8 +1,7 @@
 let ctx;
 beforeEach(() => {
   // get a new context each test
-  ctx = document.createElement('canvas')
-    .getContext('2d');
+  ctx = document.createElement('canvas').getContext('2d');
 });
 
 afterEach(() => {
@@ -11,12 +10,12 @@ afterEach(() => {
 });
 
 describe('__clearDrawCalls', () => {
-  it("should clear the list of draw calls", () => {
+  it('should clear the list of draw calls', () => {
     ctx.fillRect(1, 2, 3, 4);
     ctx.__clearDrawCalls();
   });
 
-  it("should not prevent additional draw calls from being collected", () => {
+  it('should not prevent additional draw calls from being collected', () => {
     ctx.fillRect(1, 2, 3, 4);
     ctx.__clearDrawCalls();
     ctx.fillRect(1, 2, 3, 4);

__tests__/classes/CanvasRenderingContext2D.__clearEvents.js

@@ -1,8 +1,7 @@
 let ctx;
 beforeEach(() => {
   // get a new context each test
-  ctx = document.createElement('canvas')
-    .getContext('2d');
+  ctx = document.createElement('canvas').getContext('2d');
 });
 
 afterEach(() => {
@@ -11,12 +10,12 @@ afterEach(() => {
 });
 
 describe('__clearEvents', () => {
-  it("should clear the list of events", () => {
+  it('should clear the list of events', () => {
     ctx.fillRect(1, 2, 3, 4);
     ctx.__clearEvents();
   });
 
-  it("should not prevent additional events from being collected", () => {
+  it('should not prevent additional events from being collected', () => {
     ctx.fillRect(1, 2, 3, 4);
     ctx.__clearEvents();
     ctx.fillRect(1, 2, 3, 4);

__tests__/classes/CanvasRenderingContext2D.__clearPath.js

@@ -1,8 +1,7 @@
 let ctx;
 beforeEach(() => {
   // get a new context each test
-  ctx = document.createElement('canvas')
-    .getContext('2d');
+  ctx = document.createElement('canvas').getContext('2d');
 });
 
 afterEach(() => {
@@ -11,12 +10,12 @@ afterEach(() => {
 });
 
 describe('__clearEvents', () => {
-  it("should clear the list of events", () => {
+  it('should clear the list of events', () => {
     ctx.arc(1, 2, 3, 4, 5);
     ctx.__clearPath();
   });
 
-  it("should not prevent additional events from being collected", () => {
+  it('should not prevent additional events from being collected', () => {
     ctx.arc(1, 2, 3, 4, 5);
     ctx.__clearPath();
     ctx.arc(1, 2, 3, 4, 5);

__tests__/classes/CanvasRenderingContext2D.__getClippingPath.js

@@ -1,8 +1,7 @@
 let ctx;
 beforeEach(() => {
   // get a new context each test
-  ctx = document.createElement('canvas')
-    .getContext('2d');
+  ctx = document.createElement('canvas').getContext('2d');
 });
 
 afterEach(() => {
@@ -11,11 +10,11 @@ afterEach(() => {
 });
 
 describe('__getClippingRegion', () => {
-  it("should be empty when there are no path elements", () => {
+  it('should be empty when there are no path elements', () => {
     ctx.clip();
   });
 
-  it("should store the clipping region", () => {
+  it('should store the clipping region', () => {
     ctx.rect(1, 2, 3, 4);
     ctx.arc(1, 2, 3, 4, 5);
     ctx.clip();
@@ -30,7 +29,7 @@ describe('__getClippingRegion', () => {
     ctx.clip();
   });
 
-  it("should save the clipping region correctly when saved", () => {
+  it('should save the clipping region correctly when saved', () => {
     ctx.rect(1, 2, 3, 4);
     ctx.arc(1, 2, 3, 4, 5);
     ctx.clip();
@@ -39,7 +38,7 @@ describe('__getClippingRegion', () => {
     expect(region).toStrictEqual(ctx.__getClippingRegion());
   });
 
-  it("should save the clipping region correctly when saved", () => {
+  it('should save the clipping region correctly when saved', () => {
     ctx.rect(1, 2, 3, 4);
     ctx.arc(1, 2, 3, 4, 5);
     ctx.clip();

__tests__/classes/CanvasRenderingContext2D.__getDrawCalls.js

@@ -1,8 +1,7 @@
 let ctx;
 beforeEach(() => {
   // get a new context each test
-  ctx = document.createElement('canvas')
-    .getContext('2d');
+  ctx = document.createElement('canvas').getContext('2d');
 });
 
 const img = new Image();

__tests__/classes/CanvasRenderingContext2D.__getEvents.js

@@ -1,8 +1,7 @@
 let ctx;
 beforeEach(() => {
   // get a new context each test
-  ctx = document.createElement('canvas')
-    .getContext('2d');
+  ctx = document.createElement('canvas').getContext('2d');
 });
 
 const img = new Image();

__tests__/classes/CanvasRenderingContext2D.__getPath.js

@@ -1,8 +1,7 @@
 let ctx;
 beforeEach(() => {
   // get a new context each test
-  ctx = document.createElement('canvas')
-    .getContext('2d');
+  ctx = document.createElement('canvas').getContext('2d');
 });
 
 const path = new Path2D();

__tests__/classes/CanvasRenderingContext2D.addHitRegion.js

@@ -22,12 +22,18 @@ describe('addHitRegion', () => {
     expect(() => ctx.addHitRegion()).toThrow(DOMException);
   });
 
-  it('should throw if fillRule is set and isn\'t \'evenodd\' or \'nonzero\'', () => {
-    expect(() => ctx.addHitRegion({ id: 'test', fillRule: 'wrong!' })).toThrow();
+  it("should throw if fillRule is set and isn't 'evenodd' or 'nonzero'", () => {
+    expect(() =>
+      ctx.addHitRegion({ id: 'test', fillRule: 'wrong!' })
+    ).toThrow();
   });
 
   it('should not throw if fillRule is valid', () => {
-    expect(() => ctx.addHitRegion({ id: 'test', fillRule: 'evenodd' })).not.toThrow();
-    expect(() => ctx.addHitRegion({ id: 'test', fillRule: 'nonzero' })).not.toThrow();
+    expect(() =>
+      ctx.addHitRegion({ id: 'test', fillRule: 'evenodd' })
+    ).not.toThrow();
+    expect(() =>
+      ctx.addHitRegion({ id: 'test', fillRule: 'nonzero' })
+    ).not.toThrow();
   });
 });