|
1 | | -# TypeScript library starter |
2 | | - |
3 | | -[](https://github.com/prettier/prettier) |
4 | | -[](https://greenkeeper.io/) |
5 | | -[](https://travis-ci.org/alexjoverm/typescript-library-starter) |
6 | | -[](https://coveralls.io/github/alexjoverm/typescript-library-starter) |
7 | | -[](https://david-dm.org/alexjoverm/typescript-library-starter?type=dev) |
8 | | -[](https://paypal.me/AJoverMorales) |
9 | | - |
10 | | -A starter project that makes creating a TypeScript library extremely easy. |
11 | | - |
12 | | - |
13 | | - |
14 | | -### Usage |
15 | | - |
16 | | -```bash |
17 | | -git clone https://github.com/alexjoverm/typescript-library-starter.git YOURFOLDERNAME |
18 | | -cd YOURFOLDERNAME |
19 | | - |
20 | | -# Run npm install and write your library name when asked. That's all! |
21 | | -npm install |
22 | | -``` |
23 | | - |
24 | | -**Start coding!** `package.json` and entry files are already set up for you, so don't worry about linking to your main file, typings, etc. Just keep those files with the same name. |
25 | | - |
26 | | -### Features |
27 | | - |
28 | | - - Zero-setup. After running `npm install` things will setup for you :wink: |
29 | | - - **[RollupJS](https://rollupjs.org/)** for multiple optimized bundles following the [standard convention](http://2ality.com/2017/04/setting-up-multi-platform-packages.html) and [Tree-shaking](https://alexjoverm.github.io/2017/03/06/Tree-shaking-with-Webpack-2-TypeScript-and-Babel/) |
30 | | - - Tests, coverage and interactive watch mode using **[Jest](http://facebook.github.io/jest/)** |
31 | | - - **[Prettier](https://github.com/prettier/prettier)** and **[TSLint](https://palantir.github.io/tslint/)** for code formatting and consistency |
32 | | - - **Docs automatic generation and deployment** to `gh-pages`, using **[TypeDoc](http://typedoc.org/)** |
33 | | - - Automatic types `(*.d.ts)` file generation |
34 | | - - **[Travis](https://travis-ci.org)** integration and **[Coveralls](https://coveralls.io/)** report |
35 | | - - (Optional) **Automatic releases and changelog**, using [Semantic release](https://github.com/semantic-release/semantic-release), [Commitizen](https://github.com/commitizen/cz-cli), [Conventional changelog](https://github.com/conventional-changelog/conventional-changelog) and [Husky](https://github.com/typicode/husky) (for the git hooks) |
36 | | - |
37 | | -### Importing library |
38 | | - |
39 | | -You can import the generated bundle to use the whole library generated by this starter: |
40 | | - |
41 | | -```javascript |
42 | | -import myLib from 'mylib' |
43 | | -``` |
44 | | - |
45 | | -Additionally, you can import the transpiled modules from `dist/lib` in case you have a modular library: |
46 | | - |
47 | | -```javascript |
48 | | -import something from 'mylib/dist/lib/something' |
49 | | -``` |
50 | | - |
51 | | -### NPM scripts |
52 | | - |
53 | | - - `npm t`: Run test suite |
54 | | - - `npm start`: Run `npm run build` in watch mode |
55 | | - - `npm run test:watch`: Run test suite in [interactive watch mode](http://facebook.github.io/jest/docs/cli.html#watch) |
56 | | - - `npm run test:prod`: Run linting and generate coverage |
57 | | - - `npm run build`: Generate bundles and typings, create docs |
58 | | - - `npm run lint`: Lints code |
59 | | - - `npm run commit`: Commit using conventional commit style ([husky](https://github.com/typicode/husky) will tell you to use it if you haven't :wink:) |
60 | | - |
61 | | -### Excluding peerDependencies |
62 | | - |
63 | | -On library development, one might want to set some peer dependencies, and thus remove those from the final bundle. You can see in [Rollup docs](https://rollupjs.org/#peer-dependencies) how to do that. |
64 | | - |
65 | | -Good news: the setup is here for you, you must only include the dependency name in `external` property within `rollup.config.js`. For example, if you want to exclude `lodash`, just write there `external: ['lodash']`. |
66 | | - |
67 | | -### Automatic releases |
68 | | - |
69 | | -_**Prerequisites**: you need to create/login accounts and add your project to:_ |
70 | | - - [npm](https://www.npmjs.com/) |
71 | | - - [Travis CI](https://travis-ci.org) |
72 | | - - [Coveralls](https://coveralls.io) |
73 | | - |
74 | | -_**Prerequisite for Windows**: Semantic-release uses |
75 | | -**[node-gyp](https://github.com/nodejs/node-gyp)** so you will need to |
76 | | -install |
77 | | -[Microsoft's windows-build-tools](https://github.com/felixrieseberg/windows-build-tools) |
78 | | -using this command:_ |
79 | | - |
80 | | -```bash |
81 | | -npm install --global --production windows-build-tools |
82 | | -``` |
83 | | - |
84 | | -#### Setup steps |
85 | | - |
86 | | -Follow the console instructions to install semantic release and run it (answer NO to "Do you want a `.travis.yml` file with semantic-release setup?"). |
87 | | - |
88 | | -_Note: make sure you've setup `repository.url` in your `package.json` file_ |
89 | | - |
90 | | -```bash |
91 | | -npm install -g semantic-release-cli |
92 | | -semantic-release-cli setup |
93 | | -# IMPORTANT!! Answer NO to "Do you want a `.travis.yml` file with semantic-release setup?" question. It is already prepared for you :P |
94 | | -``` |
95 | | - |
96 | | -From now on, you'll need to use `npm run commit`, which is a convenient way to create conventional commits. |
97 | | - |
98 | | -Automatic releases are possible thanks to [semantic release](https://github.com/semantic-release/semantic-release), which publishes your code automatically on [github](https://github.com/) and [npm](https://www.npmjs.com/), plus generates automatically a changelog. This setup is highly influenced by [Kent C. Dodds course on egghead.io](https://egghead.io/courses/how-to-write-an-open-source-javascript-library) |
99 | | - |
100 | | -### Git Hooks |
101 | | - |
102 | | -There is already set a `precommit` hook for formatting your code with Prettier :nail_care: |
103 | | - |
104 | | -By default, there are two disabled git hooks. They're set up when you run the `npm run semantic-release-prepare` script. They make sure: |
105 | | - - You follow a [conventional commit message](https://github.com/conventional-changelog/conventional-changelog) |
106 | | - - Your build is not going to fail in [Travis](https://travis-ci.org) (or your CI server), since it's runned locally before `git push` |
107 | | - |
108 | | -This makes more sense in combination with [automatic releases](#automatic-releases) |
109 | | - |
110 | | -### FAQ |
111 | | - |
112 | | -#### `Array.prototype.from`, `Promise`, `Map`... is undefined? |
113 | | - |
114 | | -TypeScript or Babel only provides down-emits on syntactical features (`class`, `let`, `async/await`...), but not on functional features (`Array.prototype.find`, `Set`, `Promise`...), . For that, you need Polyfills, such as [`core-js`](https://github.com/zloirock/core-js) or [`babel-polyfill`](https://babeljs.io/docs/usage/polyfill/) (which extends `core-js`). |
115 | | - |
116 | | -For a library, `core-js` plays very nicely, since you can import just the polyfills you need: |
117 | | - |
118 | | -```javascript |
119 | | -import "core-js/fn/array/find" |
120 | | -import "core-js/fn/string/includes" |
121 | | -import "core-js/fn/promise" |
122 | | -... |
123 | | -``` |
124 | | - |
125 | | -#### What is `npm install` doing on first run? |
126 | | - |
127 | | -It runs the script `tools/init` which sets up everything for you. In short, it: |
128 | | - - Configures RollupJS for the build, which creates the bundles |
129 | | - - Configures `package.json` (typings file, main file, etc) |
130 | | - - Renames main src and test files |
131 | | - |
132 | | -#### What if I don't want git-hooks, automatic releases or semantic-release? |
133 | | - |
134 | | -Then you may want to: |
135 | | - - Remove `commitmsg`, `postinstall` scripts from `package.json`. That will not use those git hooks to make sure you make a conventional commit |
136 | | - - Remove `npm run semantic-release` from `.travis.yml` |
137 | | - |
138 | | -#### What if I don't want to use coveralls or report my coverage? |
139 | | - |
140 | | -Remove `npm run report-coverage` from `.travis.yml` |
141 | | - |
142 | | -## Resources |
143 | | - |
144 | | -- [Write a library using TypeScript library starter](https://dev.to/alexjoverm/write-a-library-using-typescript-library-starter) by [@alexjoverm](https://github.com/alexjoverm/) |
145 | | -- [📺 Create a TypeScript Library using typescript-library-starter](https://egghead.io/lessons/typescript-create-a-typescript-library-using-typescript-library-starter) by [@alexjoverm](https://github.com/alexjoverm/) |
146 | | -- [Introducing TypeScript Library Starter Lite](https://blog.tonysneed.com/2017/09/15/introducing-typescript-library-starter-lite/) by [@tonysneed](https://github.com/tonysneed) |
147 | | - |
148 | | -## Projects using `typescript-library-starter` |
149 | | - |
150 | | -Here are some projects that use `typescript-library-starter`: |
151 | | - |
152 | | -- [NOEL - A universal, human-centric, replayable event emitter](https://github.com/lifenautjoe/noel) |
153 | | -- [droppable - A library to give file dropping super-powers to any HTML element.](https://github.com/lifenautjoe/droppable) |
154 | | -- [redis-messaging-manager - Pubsub messaging library, using redis and rxjs](https://github.com/tomyitav/redis-messaging-manager) |
155 | | - |
156 | | -## Credits |
157 | | - |
158 | | -Made with :heart: by [@alexjoverm](https://twitter.com/alexjoverm) and all these wonderful contributors ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)): |
159 | | - |
160 | | -<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> |
161 | | -<!-- prettier-ignore --> |
162 | | -| [<img src="https://avatars.githubusercontent.com/u/6052309?v=3" width="100px;"/><br /><sub><b>Ciro</b></sub>](https://www.linkedin.com/in/ciro-ivan-agulló-guarinos-42109376)<br />[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=k1r0s "Code") [🔧](#tool-k1r0s "Tools") | [<img src="https://avatars.githubusercontent.com/u/947523?v=3" width="100px;"/><br /><sub><b>Marius Schulz</b></sub>](https://blog.mariusschulz.com)<br />[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=mariusschulz "Documentation") | [<img src="https://avatars.githubusercontent.com/u/4152819?v=3" width="100px;"/><br /><sub><b>Alexander Odell</b></sub>](https://github.com/alextrastero)<br />[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=alextrastero "Documentation") | [<img src="https://avatars1.githubusercontent.com/u/8728882?v=3" width="100px;"/><br /><sub><b>Ryan Ham</b></sub>](https://github.com/superamadeus)<br />[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=superamadeus "Code") | [<img src="https://avatars1.githubusercontent.com/u/8458838?v=3" width="100px;"/><br /><sub><b>Chi</b></sub>](https://consiiii.me)<br />[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=ChinW "Code") [🔧](#tool-ChinW "Tools") [📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=ChinW "Documentation") | [<img src="https://avatars2.githubusercontent.com/u/2856501?v=3" width="100px;"/><br /><sub><b>Matt Mazzola</b></sub>](https://github.com/mattmazzola)<br />[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=mattmazzola "Code") [🔧](#tool-mattmazzola "Tools") | [<img src="https://avatars0.githubusercontent.com/u/2664047?v=3" width="100px;"/><br /><sub><b>Sergii Lischuk</b></sub>](http://leefrost.github.io)<br />[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=Leefrost "Code") | |
163 | | -| :---: | :---: | :---: | :---: | :---: | :---: | :---: | |
164 | | -| [<img src="https://avatars1.githubusercontent.com/u/618922?v=3" width="100px;"/><br /><sub><b>Steve Lee</b></sub>](http;//opendirective.com)<br />[🔧](#tool-SteveALee "Tools") | [<img src="https://avatars0.githubusercontent.com/u/5127501?v=3" width="100px;"/><br /><sub><b>Flavio Corpa</b></sub>](http://flaviocorpa.com)<br />[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=kutyel "Code") | [<img src="https://avatars2.githubusercontent.com/u/22561997?v=3" width="100px;"/><br /><sub><b>Dom</b></sub>](https://github.com/foreggs)<br />[🔧](#tool-foreggs "Tools") | [<img src="https://avatars1.githubusercontent.com/u/755?v=4" width="100px;"/><br /><sub><b>Alex Coles</b></sub>](http://alexbcoles.com)<br />[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=myabc "Documentation") | [<img src="https://avatars2.githubusercontent.com/u/1093738?v=4" width="100px;"/><br /><sub><b>David Khourshid</b></sub>](https://github.com/davidkpiano)<br />[🔧](#tool-davidkpiano "Tools") | [<img src="https://avatars0.githubusercontent.com/u/7225802?v=4" width="100px;"/><br /><sub><b>Aarón García Hervás</b></sub>](https://aarongarciah.com)<br />[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=aarongarciah "Documentation") | [<img src="https://avatars2.githubusercontent.com/u/13683986?v=4" width="100px;"/><br /><sub><b>Jonathan Hart</b></sub>](https://www.stuajnht.co.uk)<br />[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=stuajnht "Code") | |
165 | | -| [<img src="https://avatars0.githubusercontent.com/u/13509204?v=4" width="100px;"/><br /><sub><b>Sanjiv Lobo</b></sub>](https://github.com/Xndr7)<br />[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=Xndr7 "Documentation") | [<img src="https://avatars3.githubusercontent.com/u/7473800?v=4" width="100px;"/><br /><sub><b>Stefan Aleksovski</b></sub>](https://github.com/sAleksovski)<br />[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=sAleksovski "Code") | [<img src="https://avatars2.githubusercontent.com/u/8853426?v=4" width="100px;"/><br /><sub><b>dev.peerapong</b></sub>](https://github.com/devpeerapong)<br />[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=devpeerapong "Code") | [<img src="https://avatars0.githubusercontent.com/u/22260722?v=4" width="100px;"/><br /><sub><b>Aaron Groome</b></sub>](http://twitter.com/Racing5372)<br />[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=Racing5372 "Documentation") | [<img src="https://avatars3.githubusercontent.com/u/180963?v=4" width="100px;"/><br /><sub><b>Aaron Reisman</b></sub>](https://github.com/lifeiscontent)<br />[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=lifeiscontent "Code") | [<img src="https://avatars1.githubusercontent.com/u/32557482?v=4" width="100px;"/><br /><sub><b>kid-sk</b></sub>](https://github.com/kid-sk)<br />[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=kid-sk "Documentation") | [<img src="https://avatars0.githubusercontent.com/u/1503089?v=4" width="100px;"/><br /><sub><b>Andrea Gottardi</b></sub>](http://about.me/andreagot)<br />[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=AndreaGot "Documentation") | |
166 | | -| [<img src="https://avatars3.githubusercontent.com/u/1375860?v=4" width="100px;"/><br /><sub><b>Yogendra Sharma</b></sub>](http://TechiesEyes.com)<br />[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=Yogendra0Sharma "Documentation") | [<img src="https://avatars3.githubusercontent.com/u/7407177?v=4" width="100px;"/><br /><sub><b>Rayan Salhab</b></sub>](http://linkedin.com/in/rayan-salhab/)<br />[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=cyphercodes "Code") | |
167 | | -<!-- ALL-CONTRIBUTORS-LIST:END --> |
168 | | - |
169 | | -This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind are welcome! |
| 1 | +# Distinct Until Changed Immutable |
| 2 | + |
| 3 | +Returns an Observable that emits all items emitted by the source Observable that are deeply distinct by comparison from the previous item. |
| 4 | + |
| 5 | + If a comparator function is provided, then it will be called for each item to test for whether or not that value should be emitted. |
| 6 | + |
| 7 | + If a comparator function is not provided, a deep equality check is used by default. |
| 8 | + |
| 9 | + ## Example |
| 10 | + A simple example with numbers |
| 11 | + ```javascript |
| 12 | + import { of } from 'rxjs'; |
| 13 | + import { distinctUntilChangedImmutable } from 'distinct-until-changed-immutable'; |
| 14 | + |
| 15 | + of({a: 'a'}, {b: 'b'}, {b: 'b'}).pipe( |
| 16 | + distinctUntilChangedImmutable(), |
| 17 | + ) |
| 18 | + .subscribe(x => console.log(x)); // {a: 'a'}, {b: 'b'} |
| 19 | + ``` |
| 20 | + |
| 21 | + An example using a compare function |
| 22 | + ```typescript |
| 23 | + import { of } from 'rxjs'; |
| 24 | + import { distinctUntilChangedImmutable } from 'rxjs/operators'; |
| 25 | + |
| 26 | + interface Person { |
| 27 | + age: number, |
| 28 | + name: string |
| 29 | + } |
| 30 | + |
| 31 | + of<Person>( |
| 32 | + { age: 4, name: 'Foo'}, |
| 33 | + { age: 7, name: 'Bar'}, |
| 34 | + { age: 4, name: 'Foo'}, |
| 35 | + { age: 6, name: 'Foo'}, |
| 36 | + ).pipe( |
| 37 | + distinctUntilChangedImmutable((p: Person /*I have been cloned*/, q: Person) => p === q), |
| 38 | + ) |
| 39 | + .subscribe(x => console.log(x)); |
| 40 | + |
| 41 | + // displays: |
| 42 | + // { age: 4, name: 'Foo' } |
| 43 | + // { age: 7, name: 'Bar' } |
| 44 | + // { age: 4, name: 'Foo' } // Emitted because the parameters are immutable and we are doing a simple === check in the comparator function above |
| 45 | + // { age: 5, name: 'Foo' } |
0 commit comments