Automagical search/sort documentation page - closes #649

.circleci/config.yml

@@ -0,0 +1,20 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/node:6.15
+    steps:
+      - checkout
+      - restore_cache:
+          key: dependency-cache-{{ checksum "package.json" }}
+      - run: npm install
+      - save_cache:
+          key: dependency-cache-{{ checksum "package.json" }}
+          paths:
+            - node_modules
+      - run:
+          name: test
+          command: npm test
+      - run:
+          name: code-coverage
+          command: 'bash <(curl -s https://codecov.io/bash)'

History.md

@@ -1,23 +1,16 @@
-# TODO
-
-- Add tests for custom event handlers. 27e2d6fdeee7090eb1342a108013db898fc29b96
-- Regex in search https://github.com/javve/list.js/issues/371
-- Keep original order?
-- Automatically add item in the right place if sort is active
-- How to handle arrays?
-- Implement debouncing in search?
-- Better search https://github.com/javve/list.js/pull/312/files ?
-- Investigate sort button defaults:
-  - https://github.com/javve/list.js/issues/316
-  - https://github.com/javve/list.js/pull/301
-- Improve testability by decoupling things and make it possible to use require('') in tests
-- Add .remove() method to remove all listeners etc.
-- Example of more advanced filtering
-- Fix test suite
-- Example with multiple lists
-
 # Changelog
 
+### 1.5.1
+- **[Misc]** Added WISHLIST.md for feature requests to allow cleanup of issue list.
+- **[Misc]** Update CircleCI from 1.0 to 2.0
+- **[Website]** Use https instead of http for listjs.com
+- **[Website]** Update Contribute guidelines [See commit →](https://github.com/javve/list.js/commit/6242496de2ac5c07903fb1590a5cb5129f0887a7)
+- **[Website]** Update Jekyll & jQuery versions to remove security warnings.
+- **[Bugfix]** Use one event listener per pagination and select page via data attributes
+  [See commit →](https://github.com/javve/list.js/commit/7610c59039f3b39f52175cd1a200e935664869e8)
+- **[Bugfix]** Don't break pagination if page=0
+  [See commit →](https://github.com/javve/list.js/commit/b3db0de731d436422e016b5e17f7ceab5941cd5d)
+  [See commit →](https://github.com/javve/list.js/commit/725bc188d7ba72c7d234bda1e09fc50b40661310)
 ### 2017-01-29 v1.5.0
 - **[Feature]** Bundle fuzzySearch and pagination plugins into List.js  
   [See commit →](https://github.com/javve/list.js/commit/2f5322fd139ee6f30cef3bb5e15d382ff29f9489)

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2011-2014 Jonny Strömberg, jonnystromberg.com
+Copyright (c) 2011-2018 Jonny Strömberg, jonnystromberg.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -4,8 +4,10 @@ Perfect library for adding **search**, **sort**, **filters** and **flexibility**
 Really simple and easy to use!
 
 [![Donate](https://s3.amazonaws.com/listjs/donate-coffee.png)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=M7ZGHV75VSD2E)
+[![npm version](https://badge.fury.io/js/list.js.svg)](https://badge.fury.io/js/list.js)
 [![CircleCI](https://circleci.com/gh/javve/list.js/tree/master.svg?style=shield)](https://circleci.com/gh/javve/list.js/tree/master)
 [![codecov](https://codecov.io/gh/javve/list.js/branch/master/graph/badge.svg)](https://codecov.io/gh/javve/list.js)
+[![jsDelivr Hits](https://data.jsdelivr.com/v1/package/npm/list.js/badge?style=rounded)](https://www.jsdelivr.com/package/npm/list.js)
 
 ### Core idea
 - Simple and invisible
@@ -35,11 +37,14 @@ npm install list.js
 ```
 ##### Via CDNJS
 ```html
-<script src="//cdnjs.cloudflare.com/ajax/libs/list.js/1.4.1/list.min.js"></script>
+<script src="//cdnjs.cloudflare.com/ajax/libs/list.js/1.5.0/list.min.js"></script>
 ```
 ##### Via Direct Download
-- [Compressed list.js](https://raw.githubusercontent.com/javve/list.js/v1.4.1/dist/list.min.js)
-- [Uncompressed list.js](https://raw.githubusercontent.com/javve/list.js/v1.4.1/dist/list.js)
+- [Compressed list.js](https://raw.githubusercontent.com/javve/list.js/v1.5.0/dist/list.min.js)
+- [Uncompressed list.js](https://raw.githubusercontent.com/javve/list.js/v1.5.0/dist/list.js)
+
+### Questions / How to?
+https://stackoverflow.com/questions/tagged/list.js
 
 ### Demo / Examples
 - [Existing list](http://listjs.com/examples/existing-list)
@@ -77,5 +82,5 @@ npm install list.js
 
 ## License (MIT)
 
-Copyright (c) 2012-2017 Jonny Strömberg <[jonny.stromberg@gmail.com](mailto:jonny.stromberg@gmail.com)>
+Copyright (c) 2011-2018 Jonny Strömberg <[jonny.stromberg@gmail.com](mailto:jonny.stromberg@gmail.com)>
 [http://javve.com](http://javve.com)

Release.md

@@ -1,10 +1,10 @@
 # RELEASE
 
 1. Update version in package.json
-2. `cp package.json docs/_data/pkg.json`
-3. Commit "Version x.y.z"
-4. Tag with `git tag -a v1.14.0 -m "Version 1.14.0`
-5. Push with `git push`
-6. Push tags with `git push --tags`
-7. Update links in README.md
+2. Update links in README.md
+3. `cp package.json docs/_data/pkg.json`
+4. Commit "Version x.y.z"
+5. Tag with `git tag -a v1.14.0 -m "Version 1.14.0`
+6. Push with `git push`
+7. Push tags with `git push --tags`
 8. `npm publish`

WISHLIST.md

@@ -0,0 +1,21 @@
+# Wishlist
+- Add tests for custom event handlers. 27e2d6fdeee7090eb1342a108013db898fc29b96
+- Regex in search https://github.com/javve/list.js/issues/371
+- Keep original order? + know
+- Automatically add item in the right place if sort is active
+- How to handle arrays?
+- [Implement debouncing in search?](https://github.com/javve/list.js/issues/621)
+- Better search https://github.com/javve/list.js/pull/312/files ?
+- Investigate sort button defaults:
+  - https://github.com/javve/list.js/issues/316
+  - https://github.com/javve/list.js/pull/301
+- Improve testability by decoupling things and make it possible to use require('') in tests
+- Add .remove() method to remove all listeners etc.
+- Example of more advanced filtering
+- Example with multiple lists
+- Multiple filter functionality
+- Activ search term, sort order, filter, etc
+- [Smarter pagination window](https://github.com/javve/list.js/issues/599)
+
+# Known bugs
+Pagination does not respect .show(i, page)

__test__/create.test.js

@@ -16,13 +16,13 @@ describe('Create', function() {
 
     it('should contain one item', function() {
       expect(list.items.length).toEqual(1);
-      expect(listEl.find('li').size()).toEqual(1);
+      expect(listEl.find('li').length).toEqual(1);
     });
 
     it('should contain two items', function() {
       list.add({ name: 'Jonas' });
       expect(list.items.length).toEqual(2);
-      expect(listEl.find('li').size()).toEqual(2);
+      expect(listEl.find('li').length).toEqual(2);
     });
 
     listEl.remove();
@@ -44,13 +44,13 @@ describe('Create', function() {
 
     it('should contain one item', function() {
       expect(list.items.length).toEqual(1);
-      expect(listEl.find('li').size()).toEqual(1);
+      expect(listEl.find('li').length).toEqual(1);
     });
 
     it('should contain two items', function() {
       list.add({ name: 'Jonas' });
       expect(list.items.length).toEqual(2);
-      expect(listEl.find('li').size()).toEqual(2);
+      expect(listEl.find('li').length).toEqual(2);
     });
 
     listEl.remove();
@@ -72,13 +72,13 @@ describe('Create', function() {
 
     it('should contain one item', function() {
       expect(list.items.length).toEqual(1);
-      expect(listEl.find('tr').size()).toEqual(1);
+      expect(listEl.find('tr').length).toEqual(1);
     });
 
     it('should contain two items', function() {
       list.add({ name: 'Jonas' });
       expect(list.items.length).toEqual(2);
-      expect(listEl.find('tr').size()).toEqual(2);
+      expect(listEl.find('tr').length).toEqual(2);
     });
 
     listEl.remove();
@@ -134,13 +134,13 @@ describe('Create', function() {
 
     it('should contain one item', function() {
       expect(list.items.length).toEqual(1);
-      expect(listEl.find('li').size()).toEqual(1);
+      expect(listEl.find('li').length).toEqual(1);
     });
 
     it('should contain two items', function() {
       list.add({ name: 'Jonas' });
       expect(list.items.length).toEqual(2);
-      expect(listEl.find('li').size()).toEqual(2);
+      expect(listEl.find('li').length).toEqual(2);
     });
 
     listEl.remove();
@@ -240,7 +240,7 @@ describe('Create', function() {
         valueNames: ['name'],
         indexAsync: true,
         parseComplete: function(list) {
-          expect(listEl.find('li').size()).toEqual(162);
+          expect(listEl.find('li').length).toEqual(162);
           listEl.remove();
           done();
         }

__test__/item.test.js

@@ -78,17 +78,17 @@ describe('Item', function() {
 
   describe('Hide, show, visible', function() {
     it('should be hidden', function() {
-      expect($('#list li').size()).toEqual(1);
+      expect($('#list li').length).toEqual(1);
       item.hide();
       expect(item.visible()).toBe(false);
-      expect($('#list li').size()).toEqual(0);
+      expect($('#list li').length).toEqual(0);
     });
     it('should be visible', function() {
       item.hide();
-      expect($('#list li').size()).toEqual(0);
+      expect($('#list li').length).toEqual(0);
       item.show();
       expect(item.visible()).toBe(true);
-      expect($('#list li').size()).toEqual(1);
+      expect($('#list li').length).toEqual(1);
     });
   });