torrent-files-library

Scan directories to build a library of media files (movie or tv show) that follows torrent naming conventions

What to do with this library ?

A lot of things :

• Basic listing purposes :
  • List found movies
  • List each found tv serie
  • Detect the category of each file
• Filtering purposes :
  • Filter movies based on search parameters
  • Filter tv-shown based on search parameters
• Miscellaneous purposes
  • Create custom playlist(s)
• ...

Don't hesitate to suggest new features : it is always worthy :)

Documentation

For more examples and API details, see API documentation with manual

Installation

For npm users :

$ npm install --save torrent-files-library

for Yarn :

$ yarn add torrent-files-library

Test

npm test

To generate a test coverage report:

npm run coverage

Contributing

• If you're unsure if a feature would make a good addition, you can always create an issue first.
• We aim for 100% test coverage. Please write tests for any new functionality or changes.
• Any API changes should be fully documented.
• Make sure your code meets our linting standards. Run npm run lint to check your code.
• Be mindful of others when making suggestions and/or code reviewing.

1.5.1 (2018-02-15)

Chore

• Add ESLint messages for greenkeeper (2c43aafc3b79deaae3e2e70c2caad8e029093c7f)
• Basic set up for Babel 7 (a447a43d131c112e67c2382ef343a140ef460bcf)
• Temp fix for coverage + Babel 7 plugins (d09ac9ea5403234c66902510aa1e8a5c51e98f56)
• update dependancies (a70212da2e2e14de0bb482eccb426cd0eb660e70)
• Update devDependency : semantic-release (fc30411260ff76376b08815d59d842a3dd8286da)

CI

• Update release message - @semantic-release/git (217b2838fed0c44ef68f41fd8dc90b8620df2e92)

Docs

• Updated Docs (2ab17a5041118de65257c40372f315171c3098c7)

Perf

• use Babel/minify to make a better build (6df2740d2e2271169cd736802a147cccf0882e65)

Changelog

1.5.0 (2018-01-29)

Docs

• CHANGELOG.md updated for esdoc (424ff29a916abb70b00402c622d6f591bfd97f99)
• Docs typo (c63cce07c8134012c832322bc84c49cc55a9dca1)
• Updated docs (66e76145212cc3b0aca7c34671df53dac296aa5e)

Feat

• filterTvSeries - Filter tv series by search parameters (c2dbfd4c4fa0427ec388de7299b99ad0f1fa4631)

1.4.0 (2018-01-28)

Chore

• Little quick fix for coverage (1a6ba396c9f39ef0cb991d550c609d0c1994208d)
• Restore automatic release (83d6417a271eb5b43d05a0262328435d371e2624)

Docs

• update CHANGELOG.md (ab61d824a2dcaf8875e7b1b84a7fd76c866b1799)

Feat

• Provide a custom parsing function for the lib (352cc87b682e0652dd5b98bfc975ea1406fc28b8)

Perf

• Use bind this for Bluebird promise to prevent dummy variable (ba2da45a52d4f77e0622afd46e3fe4d86ff14d58)

1.3.0 (2018-01-27)

Chore

• Ava cannot transpile helpers yet (02757f69ac990f2860906582c4e36f0596595168)
• npm update (f543feb877aef286110313b806c0206c2673ef00)
• Remove automatic changelog (72e2b5fdf16b6c3b7d411ee332144d66f9d09160)
• remove jsdoc script (098428e1a9792a95bcb561cabac39b38336c6458)

Docs

• Add missing docs for additionalProperties (eca4eb4b9afaf4a794f8ebbb22002854ca7d58ae)
• Add missing docs for functions (e60f576f989ed3192e7d6042b6ec7c12455050fa)
• Docs completely rewritten for ESdoc (583c007450c03269650f1fdbb76035584d217df3)
• Readme and examples (bcd257f329671cc1989715a813aa477eca9143ab)
• WIP: Docs rewritten in ESDOC (8d502d88886e6e6652328cca1a8c8317e4cc44ce)

Feat

• filterMovies (c6cb3f52593c5516fffcd604c958243fb766bb26)

Fix

• Eval and = symbol in filterNumberProperty (84695f10a39d4c52586e1e7c2433e73617adca00)
• Fix founds bugs in filterMovies (09e00ad584bb19bbcf39911f43745eabefa9075a)

Test

• Add unit tests for filterMovies (42d3b94ff8b26d732f95e2a98ac0840f52c85202)
• Make expectedJson more generic (f0465f0b0ee31614a5959160cce2aeb552226c88)

1.2.4 (2018-01-21)

Fix

• Fix automatic changelog config (fa3c5ff3a15c160edc450835c2919a35722fb5fb)

1.2.3 (2018-01-21)

Chore

• Remove osx build on travis CI (too slow) (0be825b82d2101b288f45800b889696ea9aef808)
• Update dependancies (bf7971527d40dd5c53c6713b365e89daf2d61084)
• Update dependancies to fix security issues of marked (59060d89f8598edee730fa16c6f636e6f1e25c04)
• Update semantic-release preset regex (e2b839e4b02cfc7c97f6aea2444141f049162172)

Docs

• Add automatic changelog.md (6ff3328347f021b205fb4a5676ba4661b4eb3256)

Perf

• Remove comments from lib version (e54318a617b7cda1ce7d8be15d86482ba9d1aa18)

Style

• Add the emoji to github (b993c360d374272fbdc189b438c2fe2fcfc0f9e6)

Test

• Drop mocha unit tests (b0897b360f3d304dbb1090ddf2bfa5c75b6049c4)
• Fix code coverage (270a8b77f35486498da9b318d5091f8fed2c085f)

1.2.2 (2017-12-23)

Chore

• Breaking change of semantic-release (55af47fbd75387b090aa07e0d6fc67c57994ac75), closes /github.com/semantic-release/semantic-release/issues/572#issuecomment-353631426
• Make cleaning stuff (6ca25601f7d348ae4022a3f79d6936b098254980)
• Mocha V4 - compilers deprecation (55378fadbff964b8d4fc6b5559cffef424c132b0)
• Update lock file (5ec79c595ae1816c353a1da1f5a16220a9aca527)
• Use semantic-release plugins only (e61c88efc6107cbf865b3e4851a0ef6cdd00a55e)

CI

• Added Greenkeeper lockfile (f86ac271b3884832094092b524b4ca832cc6d112)

Refactor

• Remove emoji for sgcrc (4d8a6237d697a054c1828a56948c6eabf93c5689)

1.2.1 (2017-09-10)

Fix

• wrong boolean for hasPathsProvidedByUser (c8c5fa1985dd206499bd8e5af08b043290b93299)

1.2.0 (2017-09-08)

Feat

• createFromJSON - create an instance with toJSON (a69fcee4b234b12de5229d14819ebff43fab996a)

Style

• Fix babel syntax for coverage (2a8eadf0323755c1fa7bdcdacb057a0de7c3e381)

Test

• Add missing tests for events (0047fca9efd76bd51580128926c1c6bd7a412c73)

1.1.0 (2017-09-08)

Chore

• change event error to error_in_function (cd689f4ea4c7c8dd6afd84251259c256471f0477)
• remove sinonjs (9118a7c7bfeac2dc1cd11f0b28e483b777ed5fb4)

Docs

• explain default params value in constructor (1be4e825ea75506cab0903a5b7c87bd4dbac4896)
• separate jsdoc into another files (cb29a027a0acdc941d5f8ab35da636ac9b34ffed)

Feat

• Support events listeners (9461036818649b2e85dc0b8068ac926b33a3c617)

Style

• Trying to fix unhandeld promise (2f7a487a33dbe07eac47d176c3771c3dc7c89ce4)

Test

• Added tests for events (78c9fe3bceac9474fd1d77641802b65c2768fbe0)

1.0.4 (2017-09-06)

Chore

• Correct the wrong property for releaseRules (b2f17c402bf8a2451a3b32ab06259e5bc162ba58)

Docs

• change example in readme.md (a5a7e23836e7f165248d0c0d668256c623633d75)
• fix filemapping png file mess up (94337e1dcff8702aa59f9121528ef89fc5ce23b1)
• Fix png files mess up (faf9c7acd8af0841fe7c152a53843be65723d710)
• replace gif by png (0d08dab62159d48d8c0d4dec014d21323171b8af)

Perf

• overload constructor (9e091c31f4228e170004d966219b5a3e50817ba4)

Test

• Fix coverage default params missed (088e1a94b5cd2fc955f7cea527f4fd2a7bb30fb9)

1.0.3 (2017-09-03)

Docs

• Add an new example (a9d0084b732f4d7ceb0abb6626e41f16f904902d)
• create CODE_OF_CONDUCT.md (56b88c6089ffabcafb78287b540127ba324c4d32)
• updated docs (afef9f743d25f1dd8b6b283152e492de09c3e25a)
• updated docs (25edc16bc41070c21faa8ca1ad70b5abee1e35ae)
• Updated docs (3cb9b519ea3b2a73eea92952baea98244d3fad37)

Feat

• initial removeOldFiles method implementation (a5d21f84110e215da086718060a2b42e91521f45)
• toJSON() custom implementation (ca7a0cadbda175f39a0fa4386b5728ca38c50647)

Fix

• Correct getters that uses reference instead of values (064d79edcc0a7619a1cb8d68c7d6e0433834ddab)
• make JSON test cross platform (e8dd44b8264a399255b7f3fcecfc94a976f3e5c0)

Perf

• modified releaseRules for release (3a775c071ea57021bbcfca7587351349895c0d52)
• promisify addNewFiles (ffdf72a28941abedfc186f6cf5e6fb09ee83621d)
• Replace torrent name parser lib by an new one (5c428a003acb81987b35841af78d5012f6a5c8bd)

Refactor

• Add keywords to package.json and code style for docs (b9714f33e9d264d733b3ad3662fa09126afbe441)
• Make removeOldFiles method public (8887d71938abe1b61fe74ec1ff4743b88e7b9446)
• Rewrited test code (a252b833471e41086d2258acafb63e2fef794325)

Test

• Add tests for removeOldFiles (0b1edebffe7c18251ddd5cd6e148bc07233fc8f5)
• Correct tests that uses reference instead of values (49a2a1d053480a19d31926893b3f314d17c95a76)

1.0.2 (2017-08-30)

Docs

• Make docs great (b30d60e385b45dbb6396cc19dab2f4366df9bb39)

Fix

• Bug (this.timeout) due to rewrited test code (46713737549820edde50657e5523c4099bf44478)

Refactor

• Rewrited code to match ESLint rules (deb0d85d2ab31337f1d4561612f0753609acdad6)
• Rewrited tests code to match ESLint rules (39cc30c856358fa918346b199e2bfc4dd5bc0899)

1.0.1 (2017-08-29)

Fix

• Changelog missing at release (1f06fdb24009aba9da1f52e77057265b9ef5c9ee)

1.0.0 (2017-08-29)

CI

• Fix missing coverage (ac3f3612c3e087f01435247056561c048c02f419)
• Fix out of date NPM version used by travis CI (33408730e5303035a8949f7f469faddd1c72ef96)
• Replace Travis build Node.Js 4 for latest Node.Js release (747a9e5d50376b6740635181bbe05ff45cb97bb8)
• Set engines in package.json + readd job for Node.Js 6 (2f60592e058edec2d17d051babc762dd3284496e)
• Trying to set CI for semantic-release (e4403e5409b46ad585f91558c6e952e308e3172f)

Docs

• add example : how to use it ? (49b9d53d7cbd9e947f876b4c74ea9630a6a38bfc)
• Add JSDoc documentation (a2853159762783914cf069d8e74856302353b427)
• Explain how this lib will handle analysis (0b94dbe6f512b82a0bd1fd39ba42f5e450fd9819)
• Improve Documentation (5a429318fedbbf723020936b63547b7f648c46e5)
• Include an gif example for library (131711cdf617ff5aeed1ad67f176dbc0c9fb0275)
• Updated demo gifs (556ccfdd817ad5415a7c57ac8fa92072a858a61f)

Feat

• Scan Implemented (46ebf9376ae5823622784734f75cd2d133a9a25b)
• use normalize method from path (node) for paths (d3f9baffbbc546e58dcdc3d5efe6952874bc48e7)

Fix

• .gitgnore mess up with lib folder (da30f778a9d8ae936327e49b78b229214eb32d55)
• Fix Mocha bug with multiple jobs (318fab20f72dee0c3d899486c89d1fa36e7ec31f)
• Fix promisified access (c5d2cbf2413f7d2b53e47bafe2d17f211e6c22b0)
• prepublish => prepare in NPM5 (80c2633ec6623d0f26971a1b83ce08202b3ea2d0)

Test

• Add first test (5e89b605c571a3c4c7d227afbb325858aa6198c8)
• Add missing test for scan (a189a47ae6564b197d261a584d0dbbaad2965192)
• Add sub tests for scan() method (36ed79a08d9f79e89869ed8ee603060edfff2878)