perf-marks - npm Package Compare versions

Comparing version 1.0.1 to 1.1.0

CHANGELOG.md

@@ -10,2 +10,21 @@ # Change Log
 
+## [1.1.0][] - 2019-10-20
+
+### Updated
+
+- Improving CircleCI pipeline and npm scripts to run on it
+- Updating dependencies
+
+### Fixed
+
+- Moving from Travis-CI to CircleCI to fix pipeline
+- Fixing coveralls integration
+- Fixing eslint in `scripts/generate-banner.js` file
+
+### Added
+
+- Adding `contributing.md` file and section in `README.md`
+- Adding package logo
+- Adding types for `PerfMarks.end()` response
+
 ## [1.0.1][] - 2019-10-16
@@ -28,5 +47,7 @@
 [1.0.0]: https://github.com/willmendesneto/perf-marks/tree/v1.0.0
+[unreleased]: https://github.com/willmendesneto/perf-marks/compare/v1.0.1...HEAD
+[1.0.1]: https://github.com/willmendesneto/perf-marks/tree/v1.0.1
 
 
-[Unreleased]: https://github.com/willmendesneto/perf-marks/compare/v1.0.1...HEAD
-[1.0.1]: https://github.com/willmendesneto/perf-marks/tree/v1.0.1
+[Unreleased]: https://github.com/willmendesneto/perf-marks/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/willmendesneto/perf-marks/tree/v1.1.0

contributing.md

@@ -12,3 +12,3 @@ # Contributing guide
 
-- Proposing features: explain the proposed feature, what it should do, why it is useful, how users should use it. Give us as much info as possible so it will be easier to discuss, access and implement the proposed feature. When you're unsure about a certain aspect of the feature, feel free to leave it open for others to discuss and find an appropriate solution.
+- Proposing features: explain the proposed feature, what it should do, why it is useful, how users should use it. Give us as much info as possible so it will be easier to discuss, access and implement the proposed feature. When you're unsure about a certain aspect of the feature, feel free to leave it open for others to discuss and find an appropriate solution. In case of a specific scenario, please recreate that in our Stackblitz demo (http://stackblitz.com/edit/perf-marks-playground) and share the link. This will help in make the fix as quick as possible 
 
@@ -26,6 +26,1 @@ ## Proposing pull requests
 Documentation is extremely important and takes a fair deal of time and effort to write and keep updated. Please submit any and all improvements you can make to the repository's docs.
-
-## Known issues
-
-If you're using npm@3 you'll probably face some issues related to peerDependencies.
-https://github.com/npm/npm/issues/9204

lib/perf-marks.d.ts

@@ -20,2 +20,10 @@ /**
 /**
+ * Response type of `PerfMarks.end()` method
+ *
+ */
+export declare type PerfMarksPerformanceEntry = PerformanceEntry | {
+    duration?: number;
+    startTime?: number;
+};
+/**
  * Finishes performance measure of event and
@@ -25,10 +33,8 @@ * clear marks and measure if applicable
  * @param markName - Performance marker to be checked
+ * @param markNameToCompare - Optional mark to compare to
  *
- * @returns PerformanceEntry | { duration?: number; startTime?: number }
+ * @returns PerfMarksPerformanceEntry
  *
  */
-declare const end: (markName: string, markNameToCompare?: string | undefined) => PerformanceEntry | {
-    duration?: number | undefined;
-    startTime?: number | undefined;
-};
+declare const end: (markName: string, markNameToCompare?: string | undefined) => PerfMarksPerformanceEntry;
 /**
@@ -35,0 +41,0 @@ * Clear all marks and measures of performance event

lib/perf-marks.js

 /*!
- * perf-marks.js v1.0.1
+ * perf-marks.js v1.1.0
  * https://github.com/willmendesneto/perf-marks
@@ -86,4 +86,5 @@ *
    * @param markName - Performance marker to be checked
+   * @param markNameToCompare - Optional mark to compare to
    *
-   * @returns PerformanceEntry | { duration?: number; startTime?: number }
+   * @returns PerfMarksPerformanceEntry
    *
@@ -90,0 +91,0 @@ */

lib/perf-marks.min.js

 /*!
- * perf-marks.js v1.0.1
+ * perf-marks.js v1.1.0
  * https://github.com/willmendesneto/perf-marks
@@ -4,0 +4,0 @@ *

package.json

 {
   "name": "perf-marks",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "author": "Will Mendes <[e-mail]>",
@@ -56,12 +56,14 @@ "description": "The simplest and lightweight solution for User Timing API in Javascript.",
     "compile": "tsc",
-    "build": "npm run compile && babel lib --out-dir lib && npm run build-min && npm run generate-banner",
+    "build": "yarn compile && babel lib --out-dir lib && yarn build-min && yarn generate-banner",
     "build-min": "uglifyjs lib/perf-marks.js --comments '/!/' -m --screw-ie8=true -c unused=false -o lib/perf-marks.min.js",
-    "pretest": "npm run lint",
+    "pretest": "yarn lint",
     "test": "jest",
+    "pretest:ci": "yarn lint",
+    "test:ci": "jest --coverage --coverageReporters=text-lcov | coveralls",
     "check-coverage": "cat ./coverage/lcov.info | ./node_modules/.bin/coveralls && rm -rf coverage",
-    "prepublish": "npm run build",
+    "prepublish": "yarn build",
     "generate-banner": "node ./scripts/generate-banner.js",
     "bundlesize": "bundlesize",
-    "lint": "eslint '{scripts,src}/**/*.ts'",
-    "lint:fix": "eslint --fix '{scripts,src}/**/*.ts'",
+    "lint": "eslint '{scripts,src}/**/*.[tj]s'",
+    "lint:fix": "eslint --fix '{scripts,src}/**/*.[tj]s'",
     "version": "version-changelog CHANGELOG.md && changelog-verify CHANGELOG.md && git add CHANGELOG.md"
@@ -82,3 +84,3 @@ },
     "*.{js,ts,tsx}": [
-      "npm run lint:fix",
+      "yarn lint:fix",
       "git add"
@@ -85,0 +87,0 @@ ]

README.md

@@ -9,3 +9,3 @@ # Perf-marks
 
-[![Build Status](https://travis-ci.org/willmendesneto/perf-marks.svg?branch=master)](https://travis-ci.org/willmendesneto/perf-marks)
+[![Build Status](https://circleci.com/gh/willmendesneto/perf-marks.svg?style=shield)](https://circleci.com/gh/willmendesneto/perf-marks)
 [![Coverage Status](https://coveralls.io/repos/willmendesneto/perf-marks/badge.svg?branch=master)](https://coveralls.io/r/willmendesneto/perf-marks?branch=master)
@@ -17,4 +17,10 @@ [![Dependency Status](https://david-dm.org/willmendesneto/perf-marks.svg)](https://david-dm.org/willmendesneto/perf-marks)
 
+![Perf marks](./images/perf-marks.png)
+
 The simplest and lightweight solution for [User Timing API](https://developer.mozilla.org/en-US/docs/Web/API/User_Timing_API) in Javascript. Simple how it should be.
 
+## Contributing
+
+Please check our [contributing.md](https://github.com/willmendesneto/perf-marks/blob/master/contributing.md) to know more about setup and how to contribute.
+
 ## Setup and installation
@@ -21,0 +27,0 @@

scripts/generate-banner.js

@@ -0,3 +1,3 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
 const fs = require('fs');
-const path = require('path');
 const Mustache = require('mustache');
@@ -7,3 +7,2 @@ const pkg = require('../package.json');
 const FILE_ENCODING = 'utf-8';
-const EOL = '\n';
 
@@ -10,0 +9,0 @@ const readFile = filename => {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

25408

increased by4.5%

Lines of code

384

increased by1.59%

Number of lines in readme file

108

increased by5.88%

No dependency changes