feat: use TypeScript, first implementation by DudaGod · Pull Request #69 · gemini-testing/looks-same

DudaGod · 2020-05-04T20:34:29Z

What is done:

add not really strict ts config for gradual migration;
rewrite all files from .js to .ts (basically only imports/exports have changed). All types will be added in next PR;
change npm scheme publish from blacklist to whitelist. Now publish only builded source files;
add script to copy image fixtures and current d.ts file (will be deleted in next PR);
remove unused benchmark folder;
add eslint with TS support.

src/lib/diff-clusters/clusters-joiner.ts

test/test.ts

test/diff-clusters/index.ts

src/index.ts

src/lib/antialiasing-comparator.ts

src/lib/diff-area.ts

src/lib/ignore-caret-comparator/index.ts

src/lib/ignore-caret-comparator/states/state.ts

src/lib/png/index.ts

src/lib/ignore-caret-comparator/states/state.ts

test/diff-clusters/index.ts

test/test.ts

package.json

CatWithApple · 2020-05-08T08:40:36Z

package.json

+    "prepare": "npm run clean && npm run build",
+    "test": "npm run build && npm run test-unit && npm run lint",
+    "test-unit": "mocha build/test --recursive --require ./build/test/setup",
+    "lint": "eslint . --ext .js,.jsx,.ts,.tsx",


зачем jsx и tsx тут?
в проекте не будет же UI

давайте добавим prettifier. потом добавить будет больнее

.eslintrc.js

CatWithApple · 2020-05-08T08:45:39Z

src/index.ts

+import _ from 'lodash';
+import parseColor from 'parse-color';
+import colorDiff from 'color-diff';
+import * as png from './lib/png';


вроде нет смысла делать import * as для файлов этого же пакета

Не понял. Почему не имеет смысла?

мне не нравится такая запись import * as. поэтому я бы предпочёл её избегать в меру сил и возможностей.
мб я один такой :)

CatWithApple · 2020-05-08T08:48:44Z

src/lib/diff-area.ts

@@ -1,6 +1,7 @@
-'use strict';
+export = class DiffArea {


давай сразу оторвём все export = и export default

не понял зачем везде исправлять export default? Я наоборот всегда его юзаю если предполагается, что модуль будет экспортить только один класс/функцию/...

я не то чтобы сильно настаиваю, что это нужно делать при переписывании на TS прямо сейчас.
в статье представлены убедительные аргументы, кмк:
https://medium.com/devschacht/%D0%BF%D0%BE%D1%87%D0%B5%D0%BC%D1%83-%D1%8F-%D0%BF%D0%B5%D1%80%D0%B5%D1%81%D1%82%D0%B0%D0%BB-%D0%B8%D1%81%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D1%8C-%D1%8D%D0%BA%D1%81%D0%BF%D0%BE%D1%80%D1%82-%D0%BF%D0%BE-%D1%83%D0%BC%D0%BE%D0%BB%D1%87%D0%B0%D0%BD%D0%B8%D1%8E-%D0%B2-%D0%BC%D0%BE%D0%B8%D1%85-javascript-%D0%BC%D0%BE%D0%B4%D1%83%D0%BB%D1%8F%D1%85-d03e63bed126

test/setup.ts

tsconfig.common.json

.eslintrc.js

bin/copy-additional-files-to-build.sh

package.json

DudaGod · 2020-05-09T14:16:02Z

src/lib/diff-area.ts

@@ -1,6 +1,7 @@
-'use strict';
+export = class DiffArea {


не понял зачем везде исправлять export default? Я наоборот всегда его юзаю если предполагается, что модуль будет экспортить только один класс/функцию/...

test/diff-clusters/index.ts

test/test.ts

tsconfig.common.json

DudaGod · 2020-05-10T12:16:11Z

/fixed
В последнем коммите много изменений от запуска prettier-а.

CatWithApple · 2020-05-13T11:24:39Z

package.json

-  },
-  "homepage": "https://github.com/gemini-testing/looks-same"
+    "name": "looks-same",
+    "version": "7.2.2",


версия даунгрейднулась

CatWithApple · 2020-05-13T12:02:29Z

package.json

+        "chai-as-promised": "^7.1.1",
+        "copy": "^0.3.2",
+        "eslint": "^6.8.0",
+        "eslint-config-gemini-testing": "^2.8.0",


eslint-config-gemini-testing можно удалить, если не пользуемся

CatWithApple · 2020-05-13T12:06:07Z

src/index.d.ts

- * It is created specially for the needs of visual regression testing for gemini utility, but can be used for other purposes.
- */
-export = looksSame;
+// Type definitions for looks-same 5.0


а почему это отдельный файл .d.ts, а не просто ts код?

CatWithApple · 2020-05-13T12:08:33Z

src/lib/utils.ts

@@ -0,0 +1,87 @@
+"use strict";


use strict не нужен

CatWithApple · 2020-05-13T12:09:42Z

src/lib/validators.ts


-exports.validateImages = (img1, img2) => {
-    [img1, img2].forEach((i) => {
+export const validateImages = (img1, img2) => {


предпочёл бы export function validateImage ...

sipayRT · 2024-08-15T13:47:11Z

ping

DudaGod commented May 4, 2020

View reviewed changes

src/lib/diff-clusters/clusters-joiner.ts Show resolved Hide resolved

test/test.ts Show resolved Hide resolved

test/diff-clusters/index.ts Show resolved Hide resolved

DudaGod requested review from CatWithApple and sipayRT May 6, 2020 22:24

unlok reviewed May 7, 2020

View reviewed changes

xrsd approved these changes May 8, 2020

View reviewed changes

src/lib/ignore-caret-comparator/states/state.ts Outdated Show resolved Hide resolved

test/diff-clusters/index.ts Show resolved Hide resolved

test/test.ts Show resolved Hide resolved

CatWithApple reviewed May 8, 2020

View reviewed changes

DudaGod commented May 9, 2020

View reviewed changes

DudaGod added 10 commits May 10, 2020 14:02

feat: add typescript and configure npm scripts

f1cdc1c

chore: remove unused benchmark

5bdb6d4

chore: move source code to src folder

40c836f

chore: configure mocha

8b07bdd

chore: use typescript in source files, first implementation

d4a5cee

chore: use typescript in testing files, first implementation

6f59acf

chore: add eslint with TS support & fix problems

c618fba

fix: errors

b457f51

chore: add eslint rules to correctly work with prettier

908786a

chore: reformat code using prettier

984c1df

DudaGod force-pushed the FEI-17918 branch from 6f0a163 to 984c1df Compare May 10, 2020 11:10

CatWithApple approved these changes May 13, 2020

View reviewed changes

Conversation

DudaGod commented May 4, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is done:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DudaGod commented May 10, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sipayRT commented Aug 15, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

DudaGod commented May 4, 2020 •

edited

Loading