First commit

Author: ICodeMyOwnLife

.gitignore

@@ -0,0 +1,3 @@
+coverage
+dist
+node_modules

README.md

@@ -0,0 +1,19 @@
+# @codecb/iterator
+
+🌡 An implementation of the [Iterator helpers proposal](https://github.com/tc39/proposal-iterator-helpers).
+
+**Note:** This implementation does not strictly follow the proposal. It creates a new base class and works on interfaces (`Iterator`, `AsyncIterator`, `Iterable`, and `AsyncIterable`) rather than inheriting from the real, native [`%IteratorPrototype%` object](https://tc39.es/ecma262/#sec-%iteratorprototype%-object) which is quite awkward to access.
+
+The interesting aspect of this project is it uses `Generator` and `AsyncGenerator` which makes it super easy to handle iteration operations comparing to writing a `next` function ourselves.
+
+See [test cases](./test) to have a taste of what these helpers do and how to use them.
+
+## References
+
+1. [[GitHub] tc39/proposal-iterator-helpers](https://github.com/tc39/proposal-iterator-helpers)
+1. [[tc39.es] Iterator Helpers](https://tc39.es/proposal-iterator-helpers/)
+1. [[2ality] ECMAScript proposal: iterator helpers](https://2ality.com/2022/12/iterator-helpers.html)
+1. [[GitHub] nvie/itertools.js](https://github.com/nvie/itertools.js)
+1. [[GitHub] more-itertools/more-itertools](https://github.com/more-itertools/more-itertools)
+1. [[Rust] Trait std::iter::Iterator](https://doc.rust-lang.org/std/iter/trait.Iterator.html)
+1. [[Python] itertools — Functions creating iterators for efficient looping](https://docs.python.org/3/library/itertools.html)

jest.config.js

@@ -0,0 +1 @@
+module.exports = require('@codecb/jest-config-ts').config;

package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@codecb/iterator",
+  "version": "0.0.1",
+  "description": "🌡 An implementation of the Iterator helpers proposal",
+  "type": "module",
+  "license": "MIT",
+  "author": {
+    "email": "[email protected]",
+    "name": "ICodeMyOwnLife"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/code-cb/iterator"
+  },
+  "homepage": "https://github.com/code-cb/iterator",
+  "files": [
+    "./dist"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": "./dist/index.js",
+  "scripts": {
+    "build": "rollup -c rollup.config.ts --configPlugin=rollup-plugin-ts --bundleConfigAsCjs",
+    "prepublishOnly": "yarn build",
+    "test": "jest --coverage",
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.20",
+    "@babel/preset-env": "^7.20",
+    "@babel/preset-typescript": "^7.18",
+    "@codecb/babel-jest": "0.0.4",
+    "@codecb/jest-config-ts": "0.0.5",
+    "@codecb/prettierrc": "0.0.1",
+    "@codecb/ts-utils": "0.6.5",
+    "@codecb/tsconfigs": "0.0.10",
+    "@rollup/plugin-terser": "0.2.0",
+    "@types/jest": "^29.2",
+    "@types/node": "^18.11",
+    "jest": "^29.3",
+    "prettier": "^2.8",
+    "rollup": "^3.7",
+    "rollup-plugin-ts": "^3.0",
+    "typescript": "^4.9"
+  },
+  "prettier": "@codecb/prettierrc"
+}

rollup.config.ts

@@ -0,0 +1,14 @@
+import terser from '@rollup/plugin-terser';
+import { defineConfig } from 'rollup';
+import ts from 'rollup-plugin-ts';
+
+const config = defineConfig({
+  input: './src/index.ts',
+  output: {
+    dir: './dist',
+    format: 'esm',
+  },
+  plugins: [ts(), terser({ compress: { passes: 2 } })],
+});
+
+export default config;