vitalets / tinkoff-invest-api

Node.js SDK для работы с Tinkoff Invest API
45 stars 11 forks source link

Добавить инструкцию по контрибьютингу #15

Open Dennis-Nedry-From-Jurassic-Park opened 1 year ago

Dennis-Nedry-From-Jurassic-Park commented 1 year ago
  1. pull-proto
  2. compile-proto
  3. добавляем функционал (допустим positionsStream)
  4. lint & test
  5. заводим PR

примерно так @vitalets ?

vitalets commented 1 year ago

В целом да. 4. lint & test автоматически запустится на пре-коммит / пре-пуш

Dennis-Nedry-From-Jurassic-Park commented 1 year ago

@vitalets случаем нет скрипта как сбилдить под виндой контракты ?, запустил скрипт под оболочкой Linux (wsl2) контракты сбилдило, но сломалось на этом месте

bash ./scripts/compile-proto.sh     

sed: can't read s|import \* as _m0 from "protobufjs/minimal";|import _m0 from "protobufjs/minimal\.js";|g: 
No such file or directory
sed: can't read s|from "\./([^"]+)";|from "\./\1\.js";|g:
No such file or directory

в generated эти файлы

image

vitalets commented 1 year ago

По-моему для linux у sed чуть другие аргументы, вот тут обсуждение: https://unix.stackexchange.com/questions/401905/bsd-sed-vs-gnu-sed-and-i

Вообще вместо sed можно нодовский пакет заюзать (типа этого), чтобы не париться с os совместимостью.

Dennis-Nedry-From-Jurassic-Park commented 1 year ago

@vitalets если вкратце, я должен обойти контракты и заменить import * as _m0 from "protobufjs/minimal"; на import _m0 from "protobufjs/minimal.js";

верно ?

Dennis-Nedry-From-Jurassic-Park commented 1 year ago

вот эту строку что-то не разобрал s|from "./([^"]+)";|from "./\1.js";|g

а ну, добавляется .js просто по идее

vitalets commented 1 year ago

@vitalets если вкратце, я должен обойти контракты и заменить import * as _m0 from "protobufjs/minimal"; на import _m0 from "protobufjs/minimal.js";

верно ?

Да!