rename /test to /tests (#1127)

.gitignore

@@ -69,5 +69,5 @@ package-lock.json
 .babel.json
 
 .idea
-example/.config
-example/.pki
+examples/.config
+examples/.pki

CODEOWNERS

@@ -3,7 +3,7 @@
 #
 
 /docs/                              @lijiarui @hczhcz @TingYinHelen @ax4
-/example/                           @Gcaufy @hczhcz
+/examples/                          @Gcaufy @hczhcz
 /src/puppet-web/bridge.*.ts         @mukaiu
 /src/puppet-web/browser.ts          @binsee
 /src/puppet-web/browser-driver.*.ts @xjchengo

README.md

@@ -50,7 +50,7 @@ Wechaty.instance() // Singleton
 
 This bot can log all messages to the console.
 
-You can find more examples from [Wiki](https://github.com/chatie/wechaty/wiki/Example) and [Example Directory](https://github.com/chatie/wechaty/blob/master/example/).
+You can find more examples from [Wiki](https://github.com/chatie/wechaty/wiki/Examples) and [Example Directory](https://github.com/chatie/wechaty/blob/master/examples/).
 
 GETTING STARTED
 ---------------

examples/hot-reload-bot/index.js

@@ -22,7 +22,7 @@
  *
  * @deprecated
  * Use hot-import-bot instead
- * See: https://github.com/Chatie/wechaty/tree/master/example/hot-import-bot
+ * See: https://github.com/Chatie/wechaty/tree/master/examples/hot-import-bot
  *
  * DEV: docker run -ti -e --rm --volume="$(pwd)":/bot zixia/wechaty index.js
  * PROD: docker run -ti -e NODE_ENV=production --rm --volume="$(pwd)":/bot zixia/wechaty index.js
@@ -113,7 +113,7 @@ console.log(`
 
 ATTENTION: This example is DEPRECATED.
 
-Please see https://github.com/Chatie/wechaty/tree/master/example/hot-reload-bot instead.
+Please see https://github.com/Chatie/wechaty/tree/master/examples/hot-reload-bot instead.
 
 `)
 

package.json

@@ -36,7 +36,7 @@
     "test:win32": "npm run test:unit:safe",
     "test:debug": "blue-tape -r ts-node/register -r source-map-support/register src/puppet-web/bridge.spec.ts",
     "io-client": "ts-node bin/io-client",
-    "demo": "ts-node example/ding-dong-bot.ts",
+    "demo": "ts-node examples/ding-dong-bot.ts",
     "start": "npm run demo"
   },
   "git": {

script/docker.sh

@@ -25,8 +25,8 @@ case "$1" in
     ;;
 
   test)
-    echo "bats test/"
-    IMAGE_NAME="$imageName" bats test/
+    echo "bats tests/"
+    IMAGE_NAME="$imageName" bats tests/
 
     echo docker run -ti $options -v /dev/shm:/dev/shm "$imageName" test
     exec docker run -ti $options -v /dev/shm:/dev/shm "$imageName" test

script/update-license.ts

@@ -138,7 +138,7 @@ async function glob(pattern): Promise<string[]> {
 }
 
 async function main(): Promise<void> {
-  const pattern = '{bin/**/*.ts,example/**/*.{js,ts},src/**/*.{ts,js},test/**/*.ts}'
+  const pattern = '{bin/**/*.ts,examples/**/*.{js,ts},src/**/*.{ts,js},tests/**/*.ts}'
   // const pattern = 't.ts'
   const srcFileList = await glob(pattern)
   const promiseList = srcFileList.map(updateLicense)

src/contact.ts

@@ -102,7 +102,7 @@ const specialContactList: string[] = [
  * All wechat contacts(friend) will be encapsulated as a Contact.
  *
  * `Contact` is `Sayable`,
- * [Example/Contact-Bot]{@link https://github.com/Chatie/wechaty/blob/master/example/contact-bot.ts}
+ * [Example/Contact-Bot]{@link https://github.com/Chatie/wechaty/blob/master/examples/contact-bot.ts}
  */
 export class Contact implements Sayable {
   private static pool = new Map<string, Contact>()

src/friend-request.ts

@@ -31,7 +31,7 @@ import Contact  from './contact'
  * 2. receive request(in friend event)
  * 3. confirmation friendship(friend event)
  *
- * [Example/Friend-Bot]{@link https://github.com/Chatie/wechaty/blob/master/example/friend-bot.ts}
+ * [Example/Friend-Bot]{@link https://github.com/Chatie/wechaty/blob/master/examples/friend-bot.ts}
  */
 export abstract class FriendRequest {
 

src/message.ts

@@ -53,7 +53,7 @@ export type TypeName =  'attachment'
  * All wechat messages will be encapsulated as a Message.
  *
  * `Message` is `Sayable`,
- * [Example/Ding-Dong-Bot]{@link https://github.com/Chatie/wechaty/blob/master/example/ding-dong-bot.ts}
+ * [Example/Ding-Dong-Bot]{@link https://github.com/Chatie/wechaty/blob/master/examples/ding-dong-bot.ts}
  */
 export class Message implements Sayable {
   /**
@@ -186,7 +186,7 @@ export class Message implements Sayable {
   /**
    * Reply a Text or Media File message to the sender.
    *
-   * @see {@link https://github.com/Chatie/wechaty/blob/master/example/ding-dong-bot.ts|Example/ding-dong-bot}
+   * @see {@link https://github.com/Chatie/wechaty/blob/master/examples/ding-dong-bot.ts|Example/ding-dong-bot}
    * @param {(string | MediaMessage)} textOrMedia
    * @param {(Contact|Contact[])} [replyTo]
    * @returns {Promise<any>}

src/room.ts

@@ -80,7 +80,7 @@ export interface MemberQueryFilter {
  * All wechat rooms(groups) will be encapsulated as a Room.
  *
  * `Room` is `Sayable`,
- * [Example/Room-Bot]{@link https://github.com/Chatie/wechaty/blob/master/example/room-bot.ts}
+ * [Example/Room-Bot]{@link https://github.com/Chatie/wechaty/blob/master/examples/room-bot.ts}
  */
 export class Room extends EventEmitter implements Sayable {
   private static pool = new Map<string, Room>()

src/wechaty.ts

@@ -294,7 +294,7 @@ export class Wechaty extends EventEmitter implements Sayable {
    * @param   {WechatyEventFunction}  listener   - Depends on the WechatyEvent
    * @return  {Wechaty}                          - this for chain
    *
-   * More Example Gist: [Example/Friend-Bot]{@link https://github.com/wechaty/wechaty/blob/master/example/friend-bot.ts}
+   * More Example Gist: [Example/Friend-Bot]{@link https://github.com/wechaty/wechaty/blob/master/examples/friend-bot.ts}
    *
    * @example <caption>Event:scan </caption>
    * wechaty.on('scan', (url: string, code: number) => {

tsconfig.json

@@ -28,10 +28,10 @@
   ]
   , "include": [
        "bin/*.ts"
-     , "script/**/*.ts"
-     , "example/**/*.ts"
+     , "scripts/**/*.ts"
+     , "examples/**/*.ts"
      , "src/**/*.ts"
-     , "test/**/*.spec.ts"
+     , "tests/**/*.spec.ts"
      , "bot/**/*.ts"
      , "app/**/*.ts"
   ]