Initial implementation, tests, readme, types

.eslintrc

@@ -0,0 +1,16 @@
+{
+	"root": true,
+
+	"extends": "@ljharb",
+
+	"rules": {
+		"eqeqeq": ["error", "allow-null"],
+		"id-length": "off",
+		"new-cap": ["error", {
+			"capIsNewExceptions": [
+				"RequireObjectCoercible",
+				"ToObject",
+			],
+		}],
+	},
+}

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [ljharb]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: npm/es-object
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with a single custom sponsorship URL

.github/workflows/node-aught.yml

@@ -0,0 +1,15 @@
+name: 'Tests: node.js < 10'
+
+on: [pull_request, push]
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    uses: ljharb/actions/.github/workflows/node.yml@main
+    with:
+      range: '< 10'
+      type: minors
+      command: npm run tests-only
+      skip-ls-check: true

.github/workflows/node-pretest.yml

@@ -0,0 +1,10 @@
+name: 'Tests: pretest/posttest'
+
+on: [pull_request, push]
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    uses: ljharb/actions/.github/workflows/pretest.yml@main

.github/workflows/node-tens.yml

@@ -0,0 +1,14 @@
+name: 'Tests: node.js >= 10'
+
+on: [pull_request, push]
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    uses: ljharb/actions/.github/workflows/node.yml@main
+    with:
+      range: '>= 10'
+      type: minors
+      command: npm run tests-only

.github/workflows/rebase.yml

@@ -0,0 +1,9 @@
+name: Automatic Rebase
+
+on: [pull_request_target]
+
+jobs:
+  _:
+    uses: ljharb/actions/.github/workflows/rebase.yml@main
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/require-allow-edits.yml

@@ -0,0 +1,18 @@
+name: Require “Allow Edits”
+
+on: [pull_request_target]
+
+permissions:
+  contents: read
+
+jobs:
+  _:
+    permissions:
+      pull-requests: read  # for ljharb/require-allow-edits to check 'allow edits' on PR
+
+    name: "Require “Allow Edits”"
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: ljharb/require-allow-edits@main

.gitignore

@@ -133,3 +133,5 @@ dist
 npm-shrinkwrap.json
 package-lock.json
 yarn.lock
+
+.npmignore

.npmrc

@@ -1 +1,3 @@
 package-lock=false
+allow-same-version=true
+message=v%s

CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

README.md

@@ -1,2 +1,56 @@
-# es-object
-ES Object-related atoms: ToObject, RequireObjectCoercible
+# es-object <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
+
+[![github actions][actions-image]][actions-url]
+[![coverage][codecov-image]][codecov-url]
+[![License][license-image]][license-url]
+[![Downloads][downloads-image]][downloads-url]
+
+[![npm badge][npm-badge-png]][package-url]
+
+ES Object-related atoms: Object, ToObject, RequireObjectCoercible.
+
+## Example
+
+```js
+const assert = require('assert');
+
+const $Object = require('es-object');
+const ToObject = require('es-object/ToObject');
+const RequireObjectCoercible = require('es-object/RequireObjectCoercible');
+
+assert.equal($Object, Object);
+assert.throws(() => ToObject(null), TypeError);
+assert.throws(() => ToObject(undefined), TypeError);
+assert.throws(() => RequireObjectCoercible(null), TypeError);
+assert.throws(() => RequireObjectCoercible(undefined), TypeError);
+
+assert.deepEqual(RequireObjectCoercible(true), true);
+assert.deepEqual(ToObject(true), Object(true));
+
+const obj = {};
+assert.equal(RequireObjectCoercible(obj), obj);
+assert.equal(ToObject(obj), obj);
+```
+
+## Tests
+Simply clone the repo, `npm install`, and run `npm test`
+
+## Security
+
+Please email [@ljharb](https://github.com/ljharb) or see https://tidelift.com/security if you have a potential security vulnerability to report.
+
+[package-url]: https://npmjs.org/package/es-object
+[npm-version-svg]: https://versionbadg.es/ljharb/es-object.svg
+[deps-svg]: https://david-dm.org/ljharb/es-object.svg
+[deps-url]: https://david-dm.org/ljharb/es-object
+[dev-deps-svg]: https://david-dm.org/ljharb/es-object/dev-status.svg
+[dev-deps-url]: https://david-dm.org/ljharb/es-object#info=devDependencies
+[npm-badge-png]: https://nodei.co/npm/es-object.png?downloads=true&stars=true
+[license-image]: https://img.shields.io/npm/l/es-object.svg
+[license-url]: LICENSE
+[downloads-image]: https://img.shields.io/npm/dm/es-object.svg
+[downloads-url]: https://npm-stat.com/charts.html?package=es-object
+[codecov-image]: https://codecov.io/gh/ljharb/es-object/branch/main/graphs/badge.svg
+[codecov-url]: https://app.codecov.io/gh/ljharb/es-object/
+[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/ljharb/es-object
+[actions-url]: https://github.com/ljharb/es-object/actions

RequireObjectCoercible.d.ts

@@ -0,0 +1,3 @@
+declare function RequireObjectCoercible<T extends {} = {}>(value: T, optMessage?: string): T;
+
+export = RequireObjectCoercible;

RequireObjectCoercible.js

@@ -0,0 +1,11 @@
+'use strict';
+
+var $TypeError = require('es-errors/type');
+
+/** @type {import('./RequireObjectCoercible')} */
+module.exports = function RequireObjectCoercible(value) {
+	if (value == null) {
+		throw new $TypeError((arguments.length > 0 && arguments[1]) || ('Cannot call method on ' + value));
+	}
+	return value;
+};

ToObject.d.ts

@@ -0,0 +1,3 @@
+declare function ToObject<T = {}>(value: T extends object ? T : {}): T extends object ? T : object;
+
+export = ToObject;

ToObject.js

@@ -0,0 +1,10 @@
+'use strict';
+
+var $Object = require('./');
+var RequireObjectCoercible = require('./RequireObjectCoercible');
+
+/** @type {import('./ToObject')} */
+module.exports = function ToObject(value) {
+	RequireObjectCoercible(value);
+	return $Object(value);
+};

index.d.ts

@@ -0,0 +1,3 @@
+declare const Object: ObjectConstructor;
+
+export = Object;

index.js

@@ -0,0 +1,4 @@
+'use strict';
+
+/** @type {import('.')} */
+module.exports = Object;

package.json

@@ -1,14 +1,28 @@
 {
 	"name": "es-object",
 	"version": "0.0.0",
-	"description": "ES Object-related atoms: ToObject, RequireObjectCoercible",
+	"description": "ES Object-related atoms: Object, ToObject, RequireObjectCoercible",
 	"main": "index.js",
 	"exports": {
 		".": "./index.js",
+		"./RequireObjectCoercible": "./RequireObjectCoercible.js",
+		"./ToObject": "./ToObject.js",
 		"./package.json": "./package.json"
 	},
+	"sideEffects": false,
 	"scripts": {
-		"test": "echo \"Error: no test specified\" && exit 1"
+		"prepack": "npmignore --auto --commentLines=autogenerated",
+		"prepublishOnly": "safe-publish-latest",
+		"prepublish": "not-in-publish || npm run prepublishOnly",
+		"pretest": "npm run lint",
+		"test": "npm run tests-only",
+		"tests-only": "nyc tape 'test/**/*.js'",
+		"posttest": "aud --production",
+		"prelint": "evalmd README.md",
+		"lint": "eslint --ext=js,mjs .",
+		"postlint": "tsc -p . && eclint check $(git ls-files | xargs find 2> /dev/null | grep -vE 'node_modules|\\.git' | grep -v dist/)",
+		"version": "auto-changelog && git add CHANGELOG.md",
+		"postversion": "auto-changelog && git add CHANGELOG.md && git commit --no-edit --amend && git tag -f \"v$(node -e \"console.log(require('./package.json').version)\")\""
 	},
 	"repository": {
 		"type": "git",
@@ -26,5 +40,40 @@
 	"bugs": {
 		"url": "https://github.com/ljharb/es-object/issues"
 	},
-	"homepage": "https://github.com/ljharb/es-object#readme"
+	"homepage": "https://github.com/ljharb/es-object#readme",
+	"dependencies": {
+		"es-errors": "^1.3.0"
+	},
+	"devDependencies": {
+		"@ljharb/eslint-config": "^21.1.0",
+		"@ljharb/tsconfig": "^0.2.0",
+		"@types/tape": "^5.6.4",
+		"aud": "^2.0.4",
+		"auto-changelog": "^2.4.0",
+		"eclint": "^2.8.1",
+		"eslint": "^8.8.0",
+		"evalmd": "^0.0.19",
+		"in-publish": "^2.0.1",
+		"npmignore": "^0.3.1",
+		"nyc": "^10.3.2",
+		"safe-publish-latest": "^2.0.0",
+		"tape": "^5.7.5",
+		"typescript": "next"
+	},
+	"auto-changelog": {
+		"output": "CHANGELOG.md",
+		"template": "keepachangelog",
+		"unreleased": false,
+		"commitLimit": false,
+		"backfillLimit": false,
+		"hideCredit": true
+	},
+	"publishConfig": {
+		"ignore": [
+			".github/workflows"
+		]
+	},
+	"engines": {
+		"node": ">= 0.4"
+	}
 }

test/index.js

@@ -0,0 +1,28 @@
+'use strict';
+
+var test = require('tape');
+
+var $Object = require('../');
+var ToObject = require('..//ToObject');
+var RequireObjectCoercible = require('..//RequireObjectCoercible');
+
+test('errors', function (t) {
+	t.equal($Object, Object);
+	// @ts-expect-error
+	t['throws'](function () { ToObject(null); }, TypeError);
+	// @ts-expect-error
+	t['throws'](function () { ToObject(undefined); }, TypeError);
+	// @ts-expect-error
+	t['throws'](function () { RequireObjectCoercible(null); }, TypeError);
+	// @ts-expect-error
+	t['throws'](function () { RequireObjectCoercible(undefined); }, TypeError);
+
+	t.deepEqual(RequireObjectCoercible(true), true);
+	t.deepEqual(ToObject(true), Object(true));
+
+	var obj = {};
+	t.equal(RequireObjectCoercible(obj), obj);
+	t.equal(ToObject(obj), obj);
+
+	t.end();
+});

tsconfig.json

@@ -0,0 +1,6 @@
+{
+	"extends": "@ljharb/tsconfig",
+	"compilerOptions": {
+		"target": "es5",
+	},
+}