Merge pull request #4 from mathiasbynens/nr/es-shim-api

nicolo-ribaudo · web-flow · commit aa59dce18339 · 2020-05-17T16:19:05.000+02:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,6 @@
+root = true
+
+[*]
+indent_style = tab
+end_of_line = lf
+insert_final_newline = true
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,7 @@ coverage
 
 # Installed npm modules
 node_modules
+package-lock.json
 
 # Folder view configuration files
 .DS_Store
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+package-lock=false
diff --git a/.travis.yml b/.travis.yml
@@ -1,5 +1,7 @@
+version: ~> 1.0
 language: node_js
-node_js:
-  - "0.10"
-script:
-  "node tests/tests.js"
+os:
+ - linux
+import:
+ - ljharb/travis-ci:node/all.yml
+ - ljharb/travis-ci:node/pretest.yml
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
 # ES6 `String.prototype.codePointAt` polyfill [![Build status](https://travis-ci.org/mathiasbynens/String.prototype.codePointAt.svg?branch=master)](https://travis-ci.org/mathiasbynens/String.prototype.codePointAt)
 
-A robust & optimized ES3-compatible polyfill for [the `String.prototype.codePointAt` method in ECMAScript 6](http://people.mozilla.org/~jorendorff/es6-draft.html#sec-string.prototype.codepointat).
+A robust & optimized polyfill for [the `String.prototype.codePointAt` method in ECMAScript 6](http://people.mozilla.org/~jorendorff/es6-draft.html#sec-string.prototype.codepointat).
+
+This package implements the [es-shim API](https://github.com/es-shims/api) interface. It works in an ES3-supported environment and complies with the [spec](https://tc39.es/ecma262/#sec-string.prototype.codepointat).
 
 Other polyfills for `String.prototype.codePointAt` are available:
 
@@ -10,12 +12,6 @@ Other polyfills for `String.prototype.codePointAt` are available:
 
 ## Installation
 
-In a browser:
-
-```html
-<script src="codepointat.js"></script>
-```
-
 Via [npm](http://npmjs.org/):
 
 ```bash
@@ -32,6 +28,16 @@ require('string.prototype.codepointat');
 require('String.prototype.codePointAt');
 ```
 
+In a browser:
+
+```html
+<script src="https://bundle.run/string.prototype.codepointat"></script>
+```
+
+> **NOTE**: It's recommended that you install this module using a package manager
+> such as `npm`, because loading multiple polyfills from a CDN (such as `bundle.run`)
+> will lead to duplicated code.
+
 ## Notes
 
 [A polyfill + test suite for `String.fromCodePoint`](https://mths.be/fromcodepoint) is available, too.
diff --git a/auto.js b/auto.js
@@ -0,0 +1,3 @@
+/*! https://mths.be/codepointat v1.0.0 by @mathias */
+
+require('./shim')();
diff --git a/codepointat.js b/codepointat.js
diff --git a/implementation.js b/implementation.js
@@ -0,0 +1,34 @@
+/*! https://mths.be/codepointat v1.0.0 by @mathias */
+
+'use strict';
+
+var callBound = require('es-abstract/helpers/callBound');
+var RequireObjectCoercible = require('es-abstract/2019/RequireObjectCoercible');
+var ToString = require('es-abstract/2019/ToString');
+var ToInteger = require('es-abstract/2019/ToInteger');
+var StringCharCodeAt = callBound('String.prototype.charCodeAt');
+
+module.exports = function codePointAt(position) {
+	var O = RequireObjectCoercible(this);
+	var string = ToString(O);
+	var size = string.length;
+	var index = ToInteger(position);
+	// Account for out-of-bounds indices:
+	if (index < 0 || index >= size) {
+		return undefined;
+	}
+	// Get the first code unit
+	var first = StringCharCodeAt(string, index);
+	var second;
+	if ( // check if it’s the start of a surrogate pair
+		first >= 0xD800 && first <= 0xDBFF && // high surrogate
+		size > index + 1 // there is a next code unit
+	) {
+		second = StringCharCodeAt(string, index + 1);
+		if (second >= 0xDC00 && second <= 0xDFFF) { // low surrogate
+			// https://mathiasbynens.be/notes/javascript-encoding#surrogate-formulae
+			return (first - 0xD800) * 0x400 + second - 0xDC00 + 0x10000;
+		}
+	}
+	return first;
+};
diff --git a/index.js b/index.js
@@ -0,0 +1,20 @@
+/*! https://mths.be/codepointat v1.0.0 by @mathias */
+
+'use strict';
+
+var callBind = require('es-abstract/helpers/callBind');
+var define = require('define-properties');
+
+var implementation = require('./implementation');
+var getPolyfill = require('./polyfill');
+var shim = require('./shim');
+
+var boundCodePointAt = callBind(implementation);
+
+define(boundCodePointAt, {
+	getPolyfill: getPolyfill,
+	implementation: implementation,
+	shim: shim
+});
+
+module.exports = boundCodePointAt;
diff --git a/package.json b/package.json
@@ -3,7 +3,15 @@
 	"version": "0.2.1",
 	"description": "A robust & optimized `String.prototype.codePointAt` polyfill, based on the ECMAScript 6 specification.",
 	"homepage": "https://mths.be/codepointat",
-	"main": "codepointat.js",
+	"main": "index.js",
+	"exports": {
+		".": "./index.js",
+		"./auto": "./auto.js",
+		"./shim": "./shim.js",
+		"./getPolyfill": "./getPolyfill.js",
+		"./implementation": "./implementation.js",
+		"./package.json": "./package.json"
+	},
 	"keywords": [
 		"string",
 		"unicode",
@@ -21,12 +29,21 @@
 		"url": "https://github.com/mathiasbynens/String.prototype.codePointAt.git"
 	},
 	"bugs": "https://github.com/mathiasbynens/String.prototype.codePointAt/issues",
-	"files": [
-		"LICENSE-MIT.txt",
-		"codepointat.js"
-	],
 	"scripts": {
-		"test": "node tests/tests.js",
-		"cover": "istanbul cover --report html --verbose --dir coverage tests/tests.js"
+		"pretest": "es-shim-api --bound",
+		"test": "npm run tests-only",
+		"tests-only": "tape 'tests/*.js'",
+		"cover": "istanbul cover --report html --verbose --dir coverage tape 'tests/*.js'"
+	},
+	"dependencies": {
+		"es-abstract": "^1.17.5"
+	},
+	"devDependencies": {
+		"@es-shims/api": "^2.1.2",
+		"define-properties": "^1.1.3",
+		"function-bind": "^1.1.1",
+		"functions-have-names": "^1.2.1",
+		"istanbul": "^0.4.5",
+		"tape": "^5.0.0"
 	}
 }
diff --git a/polyfill.js b/polyfill.js
@@ -0,0 +1,9 @@
+/*! https://mths.be/codepointat v1.0.0 by @mathias */
+
+'use strict';
+
+var implementation = require('./implementation');
+
+module.exports = function getPolyfill() {
+	return String.prototype.codePointAt || implementation;
+};
diff --git a/shim.js b/shim.js
@@ -0,0 +1,17 @@
+/*! https://mths.be/codepointat v1.0.0 by @mathias */
+
+'use strict';
+
+var define = require('define-properties');
+
+var getPolyfill = require('./polyfill');
+
+module.exports = function shimCodePointAt() {
+	var polyfill = getPolyfill();
+
+	if (String.prototype.codePointAt !== polyfill) {
+		define(String.prototype, { codePointAt: polyfill });
+	}
+
+	return polyfill;
+}
diff --git a/tests/index.js b/tests/index.js
@@ -0,0 +1,12 @@
+'use strict';
+
+var codePointAt = require('../');
+var test = require('tape');
+
+var runTests = require('./tests');
+
+test('as a function', function (t) {
+	runTests(codePointAt, t);
+
+	t.end();
+});
diff --git a/tests/shimmed.js b/tests/shimmed.js
@@ -0,0 +1,30 @@
+'use strict';
+
+var codePointAt = require('../');
+codePointAt.shim();
+
+var test = require('tape');
+var defineProperties = require('define-properties');
+var bind = require('function-bind');
+var isEnumerable = Object.prototype.propertyIsEnumerable;
+var functionsHaveNames = require('functions-have-names')();
+
+var runTests = require('./tests');
+
+test('shimmed', function (t) {
+	t.equal(String.prototype.codePointAt.length, 1, 'String#codePointAt has a length of 1');
+
+	t.test('Function name', { skip: !functionsHaveNames }, function (st) {
+		st.equal(String.prototype.codePointAt.name, 'codePointAt', 'String#codePointAt has name "codePointAt"');
+		st.end();
+	});
+
+	t.test('enumerability', { skip: !defineProperties.supportsDescriptors }, function (et) {
+		et.equal(false, isEnumerable.call(String.prototype, 'codePointAt'), 'String#codePointAt is not enumerable');
+		et.end();
+	});
+
+	runTests(bind.call(Function.call, String.prototype.codePointAt), t);
+
+	t.end();
+});
diff --git a/tests/tests.js b/tests/tests.js

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+/! https://mths.be/codepointat v1.0.0 by @mathias /`
	`2`	`+`
	`3`	`+require('./shim')();`