refactor: rewrite with typescript, remove jquery support

Author: hustcc

.babelrc

@@ -0,0 +1,9 @@
+module.exports = {
+  rules: {
+    'type-enum': [
+      2,
+      'always',
+      ['build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test', 'wip'],
+    ],
+  },
+};

.commitlintrc.js

@@ -0,0 +1,18 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": "./tsconfig.ci.json"
+  },
+  "plugins": ["@typescript-eslint"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+    "prettier/@typescript-eslint"
+  ],
+  "rules": {
+    "@typescript-eslint/ban-ts-ignore": 1,
+    "@typescript-eslint/camelcase": 0
+  }
+}

.eslintrc

@@ -0,0 +1,8 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "printWidth": 120,
+  "arrowParens": "always"
+}

.prettierrc

@@ -13,5 +13,7 @@ install:
   - export DISPLAY=':99.0'
   - Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
   - npm install
+script:
+  - npm run ci
 after_success:
   - npm run coveralls

.travis.yml

@@ -50,12 +50,11 @@ npm install timeago.js
 
  - Import
 
-```js
-// ES6
+```ts
 import { format, render, cancel, register } from 'timeago.js';
 
-// commonjs
-const { format, render, cancel, register } = require('timeago.js');
+// or
+import * as timeago from 'timeago.js';
 ```
 
 or import with `script` in html file and access global variable `timeago`.
@@ -66,7 +65,7 @@ or import with `script` in html file and access global variable `timeago`.
 
  - Usage
 
-```js
+```ts
 // format the time with locale
 format('2016-06-12', 'en_US');
 ```
@@ -89,7 +88,7 @@ There only 4 API:
 
 Just format date into a string.
 
-```js
+```ts
 import { format, render, cancel, register } from 'timeago.js';
 
 // format timestamp
@@ -117,13 +116,15 @@ You can `render` a dom node with automatic rendering.
 HTML code:
 
 ```html
-<div class="needs_to_be_rendered" datetime="2016-06-30 09:20:00"></div>
+<div class="needs-tobe-rendered" datetime="2016-06-30 09:20:00"></div>
 ```
 
 Javascript code:
 
-```js
-var nodes = document.querySelectorAll('.needs_to_be_rendered');
+```ts
+import * as timeago from 'timeago.js';
+
+const nodes = document.querySelectorAll('.needs-tobe-rendered');
 
 // use render method to render nodes in real time
 timeago.render(nodes, 'zh_CN');
@@ -135,7 +136,7 @@ timeago.cancel();
 timeago.cancel(nodes[0])
 ```
 
-The input for `render` method should be DOM object / array, pure javascript DOM node or jQuery DOM object supported.
+The input for `render` method should be DOM object / array, pure javascript DOM node ~~or jQuery DOM object supported~~.
 
 The `cancel` method clears all the render timers and release all resources of the instance. Optionally it accepts a single node to cancel timer just for it.
 
@@ -146,12 +147,12 @@ The `cancel` method clears all the render timers and release all resources of th
 
 Default locale is **`en_US`**, and the library supports `en_US` and `zh_CN`. You can register your own language with `register`.
 
-```js
+```ts
 // the local dict example is below.
-const localeFunc = (number, index, total_sec) => {
+const localeFunc = (number: number, index: number, totalSec: number): [string, string] => {
   // number: the timeago / timein number;
   // index: the index of array below;
-  // total_sec: total seconds between date to be formatted and today's date;
+  // totalSec: total seconds between date to be formatted and today's date;
   return [
     ['just now', 'right now'],
     ['%s seconds ago', 'in %s seconds'],
@@ -187,7 +188,7 @@ Check out more [locales](src/lang).
 2. **locale translations**: The library needs more locale translations. You can:
 
  - Open an issue to write the locale translations, or submit a pull request. How to ? see [locales translation](src/lang/).
- - Please **test** the locale by exec `npm test`. How to write testcase, see [locales test cases](__tests__/lang/).
+ - Please **test** the locale by exec `npm test`. How to write test cases, see [locales test cases](__tests__/lang/).
 
 
 

README.md

@@ -48,12 +48,11 @@ npm install timeago.js
 
  - 引入
 
-```js
-// ES6
+```ts
 import { format, render, cancel, register } from 'timeago.js';
 
-// commonjs
-const { format, render, cancel, register } = require('timeago.js');
+// or
+import * as timeago from 'timeago.js';
 ```
 
 或者使用 `script` 在 html 文件中引入，然后就可以使用全局的变量 `timeago`。
@@ -64,7 +63,7 @@ const { format, render, cancel, register } = require('timeago.js');
 
  - 使用
 
-```js
+```ts
 // 格式化日期
 format('2016-06-12', 'en_US');
 ```
@@ -115,13 +114,13 @@ format(Date.now() - 11 * 1000 * 60 * 60); // returns '11 hours ago'
 HTML code:
 
 ```html
-<div class="needs_to_be_rendered" datetime="2016-06-30 09:20:00"></div>
+<div class="needs-tobe-rendered" datetime="2016-06-30 09:20:00"></div>
 ```
 
 Javascript code:
 
 ```js
-var nodes = document.querySelectorAll('.needs_to_be_rendered');
+var nodes = document.querySelectorAll('.needs-tobe-rendered');
 
 // use render method to render nodes in real time
 timeago.render(nodes, 'zh_CN');
@@ -133,9 +132,9 @@ timeago.cancel();
 timeago.cancel(nodes[0])
 ```
 
-`render` 函数的输入必须是一个 dom 元素或者数组，JavaScript dom 和 JQuery 的 dom 均支持。
+`render` 函数的输入必须是一个 dom 元素或者数组，JavaScript dom ~~和 JQuery 的 dom 均~~支持。
 
-`cancel` 清楚实时渲染，如果传入 dom，则清除这个 dom 的实时渲染，否则清除所有。
+`cancel` 清除实时渲染，如果传入 dom，则清除这个 dom 的实时渲染，否则清除所有。
 
 > 被渲染的 dom 元素必须包含一个 `datetime` 属性，用于被格式化的日期。
 
@@ -146,10 +145,10 @@ timeago.cancel(nodes[0])
 
 ```js
 // the local dict example is below.
-const localeFunc = (number, index, total_sec) => {
+const localeFunc = (number, index, totalSec) => {
   // number: the timeago / timein number;
   // index: the index of array below;
-  // total_sec: total seconds between date to be formatted and today's date;
+  // totalSec: total seconds between date to be formatted and today's date;
   return [
     ['just now', 'right now'],
     ['%s seconds ago', 'in %s seconds'],

README_zh.md

@@ -0,0 +1,32 @@
+/**
+ * Created by hustcc on 18/5/20.
+ * Contract: [email protected]
+ */
+
+import { format, render, cancel, register } from '../src/';
+
+describe('index', () => {
+  test('all', () => {
+    expect(format).toBeInstanceOf(Function);
+    expect(render).toBeInstanceOf(Function);
+    expect(cancel).toBeInstanceOf(Function);
+    expect(register).toBeInstanceOf(Function);
+  });
+
+  test('format', () => {
+    expect(format(+new Date() - 5000)).toBe('just now');
+
+    expect(format(+new Date() - 1000 * 1000, 'zh_CN')).toBe('16 分钟前');
+  });
+
+  test('cancel', () => {
+    cancel();
+
+    const node = {
+      getAttribute: () => 1,
+    };
+
+    // @ts-ignore
+    cancel(node);
+  });
+});

__tests__/index.spec.js

@@ -1,4 +1,4 @@
-import { advanceBy, advanceTo, clear } from 'jest-date-mock';
+import { advanceTo, clear } from 'jest-date-mock';
 import { register, format } from '../../src';
 import cs from '../../src/lang/cs';
 
@@ -28,7 +28,6 @@ describe('cs', () => {
     test('minute', () => {
       advanceTo(1000 * 60);
       expect(format(date, 'cs')).toEqual('před minutou');
-
     });
 
     test('minutes', () => {
@@ -49,7 +48,6 @@ describe('cs', () => {
     test('yesterday', () => {
       advanceTo(1000 * 60 * 60 * 24);
       expect(format(date, 'cs')).toEqual('včera');
-
     });
 
     test('days', () => {
@@ -60,7 +58,6 @@ describe('cs', () => {
     test('last week', () => {
       advanceTo(1000 * 60 * 60 * 24 * 7);
       expect(format(date, 'cs')).toEqual('minulý týden');
-
     });
 
     test('weeks', () => {

__tests__/index.spec.ts

@@ -1,4 +1,4 @@
-import { advanceBy, advanceTo, clear } from 'jest-date-mock';
+import { advanceTo, clear } from 'jest-date-mock';
 import { register, format } from '../../src';
 import fa from '../../src/lang/fa';
 

__tests__/lang/cs.spec.js renamed to __tests__/lang/cs.spec.ts

@@ -1,4 +1,4 @@
-import { advanceBy, advanceTo, clear } from 'jest-date-mock';
+import { advanceTo, clear } from 'jest-date-mock';
 import { register, format } from '../../src';
 import he from '../../src/lang/he';
 

__tests__/lang/fa.spec.js renamed to __tests__/lang/fa.spec.ts

@@ -2,13 +2,12 @@
  * Created by porcus on 2018/10/09.
  * Contact: [email protected]
  */
-import { advanceBy, advanceTo, clear } from 'jest-date-mock';
+import { advanceTo, clear } from 'jest-date-mock';
 import { format, register } from '../../src';
 import hi_IN from '../../src/lang/hi_IN';
 
 register('hi_IN', hi_IN);
 
-
 let date = new Date();
 
 beforeEach(() => {

__tests__/lang/he.spec.js renamed to __tests__/lang/he.spec.ts

@@ -1,4 +1,4 @@
-import { advanceBy, advanceTo, clear } from 'jest-date-mock';
+import { advanceTo, clear } from 'jest-date-mock';
 import { register, format } from '../../src';
 import it from '../../src/lang/it';
 
@@ -28,7 +28,7 @@ describe('it', () => {
     expect(format(date, 'it')).toEqual('30 minuti fa');
 
     advanceTo(1000 * 60 * 60);
-    expect(format(date, 'it')).toEqual('un\'ora fa');
+    expect(format(date, 'it')).toEqual("un'ora fa");
 
     advanceTo(1000 * 60 * 60 * 8);
     expect(format(date, 'it')).toEqual('8 ore fa');
@@ -71,7 +71,7 @@ describe('it', () => {
     expect(format(date, 'it')).toEqual('fra 30 minuti');
 
     advanceTo(-1000 * 60 * 60);
-    expect(format(date, 'it')).toEqual('fra un\'ora');
+    expect(format(date, 'it')).toEqual("fra un'ora");
 
     advanceTo(-1000 * 60 * 60 * 8);
     expect(format(date, 'it')).toEqual('fra 8 ore');

__tests__/lang/hi_IN.spec.js renamed to __tests__/lang/hi_IN.spec.ts

@@ -2,13 +2,12 @@
  * Created by hustcc on 18/5/24.
  * Contact: [email protected]
  */
-import { advanceBy, advanceTo, clear } from 'jest-date-mock';
+import { advanceTo, clear } from 'jest-date-mock';
 import { format, register } from '../../src';
 import ka from '../../src/lang/ka';
 
 register('ka', ka);
 
-
 let date = new Date();
 
 beforeEach(() => {