draft: add sbt usage page #1016

i10416 · 2022-09-16T14:12:22Z

sbt の使い方を最低限(例: Scala バージョンの指定やライブラリの追加方法)書いてある方が初心者に優しいのではないか？と思って追加した.

また、詳細を管理するのは手間なので以下の一文を冒頭に入れた.

以下ではsbtの基本的な機能を紹介しますが、詳細は公式ドキュメントを参照してください。

close #1012

xuwei-k · 2022-09-16T22:22:31Z

textlint大量に落ちてる

src/sbt-usage.md

xuwei-k · 2022-09-16T22:25:29Z

src/sbt-usage.md

+  )
+```
+
+sbt コンソールから `++2.13.8 <sbt command>` とすることで Scala のバージョンを指定して sbt のコマンドを実行したり、


コマンドっていう用語、sbtの公式のCommandやTaskとしてのコマンドとの違いがややこしいような

公式ページ https://www.scala-sbt.org/1.x/docs/ja/Running.html 見る限りですが、こっちの方も「コマンド」と書いてあるのでOKな気がしてますけど。なんか勘違いしてますかね？

xuwei-k · 2022-09-16T22:26:49Z

そもそも根本的に前もどこかで何度か書いたけど、sbt自体は公式ページ参照してもらって、足りないとかわかりずらいなら、そっちを充実させればいい気がするから、ここに追加するのはあまり賛成ではないなぁ

src/sbt-usage.md

xuwei-k · 2022-09-16T22:30:14Z

src/sbt-usage.md

+  .settings(
+    scalaVersion := "3.2.0",
+    libraryDependencies ++= Seq(
+        "log4j" % "log4j" % "1.2.17"


例とはいえ脆弱性で話題になったlog4jの1系は… 🤔

log4j、(mavenの用語だと)groupIdとartifactIdが同じなのも、例としてややこしいか？ 🤔

(良くも悪くも)知名度高い Java のライブラリだとこれかなって思いましたが、”groupIdとartifactIdが同じなのも...” を考慮すると他のライブラリの方がいいですね

知名度が高いJavaライブラリだとなんでしょうね……。Webアプリ系だとMockitoとか？

https://github.com/mockito/mockito

たとえば、

"org.mockito" % "mockito-core" % "3.0.0" % Test

とか。

xuwei-k · 2022-09-16T22:31:09Z

src/sbt-usage.md

+  )
+```
+
+### JVM以外のプラットフォームからライブラリを利用する


plugins.sbtのaddSbtPluginの記述がないような

もう少し言いたいこと足しておくと

本当に最低限とはいえ、とりあえず書いてある通りにやるとjsやnativeで動くサンプルを作れる記述にするべき？、なら、plugins.sbtにjsやnativeの記述例も追加する(version管理するなら、その分メンテコスト上がるが)

あるいは、あえてその部分を省略したことを明記して詳細は公式見てね、としてリンク貼る？

とにかく「jsやnative向けのpluginもあるよ」という紹介というか雰囲気を掴むだけにするなら、逆にもっと簡素にする？

その他？ 🤔

plugins.sbtのaddSbtPluginの記述がないような

入れるべきか迷って書かなかったのですが、簡潔にして公式ドキュメントに流す方がメンテしやすくてよさそうですね

ただ、日本語で書かれているテキストがあるという点が初心者からしたらうれしいかも？とは思いました.

ひとまず、ライブラリを追加する際に %% と %%%があることを言及するためにscalajs の例は残します.

@i10416 ちょい難しいところかと思うんですが、最低限と割り切るなら需要が低いjsやnativeは切り捨てて、そっちは公式ドキュメント参照してね、がいいのかなと考えてます。%%% に言及したい積極的な理由ってあったりするでしょうか？

xuwei-k · 2022-09-16T22:33:00Z

src/sbt-usage.md

+アプリケーションやライブラリとしては利用しないがテストで利用するライブラリが必要な場合は次のように書きます.
+ライブラリ名の後ろに `% Test` があることに注意してください. 
+このように指定したライブラリはテスト用のコード(一般的には`src/test/scala` 以下にある Scala コード)からしか利用できず
+リリースされるアプリケーションやライブラリには含まれません. JavaScript の package.json に含まれる


Javaの記述は消すけどJSの記述は例に出すのは若干疑問が残るが🤔
まぁ他にもっと良い例がないならいいか？

自分の観測範囲の問題かもしれませんが Java よりも Python や JavaScript を使っている方が多いのでユーザー数の多い言語のものを例にあげました. Python は requirements.txt や poetry などいろいろあるので js を例にしました.

他言語の経験があること前提なら一番身近であろうJSを例に出すのも……まあありかもです。あるいは、とりあえず「こういうもんです」とするのも手かもとは思います。

src/sbt-usage.md

xuwei-k · 2022-09-16T22:36:21Z

src/sbt-usage.md

+  .settings(
+    scalaVersion := "3.2.0",
+    libraryDependencies ++= Seq(
+        "com.typelevel" %% "cats-core" % "2.7.0"


他もいくつか含めて、インデントが変なような

この場合だと、

Seq( "com.typelevel" %% "cats-core" % "2.7.0" )

になってて欲しいみたいな話ですか？（インデント幅の話？）

xuwei-k · 2022-09-16T22:37:20Z

src/sbt-usage.md

+
+このように書けば `src/main/scala` 以下にある Scala ファイルから下のようにライブラリをインポートして利用できます.
+
+```scala


ここはmdocで書くか？

確かにmdocが良さそうです。

xuwei-k · 2022-09-16T22:38:24Z

catsどうせなら最新版の方が

xuwei-k · 2022-09-17T11:20:30Z

src/sbt-usage.md

+他の Scala アプリケーションやライブラリから利用するライブラリを書く際は、しばしば複数の Scala バージョン向けに
+ライブラリをビルドします.


そこまで応用向けな話でもないけど、Scala初学者が学ぶため、という方向性のテキストなら、この話どの程度入れるべきか？というと微妙か・・・？ 🤔

他の言語の経験者で Scala 初学者の場合、アプリケーションでなくライブラリを書くことにも関心がある方がいるのでは？と思ったのでクロスビルドについて記述しました.

src/sbt-usage.md

xuwei-k · 2022-09-17T11:41:17Z

そもそも、もしsbtの記述を今より入れるにしても、何をどのくらい入れるか？を結構考えないと、統一性というか「初学者向け」という観点からすると色々微妙になりそうな気がするんだよなぁ。

「これを入れるならこっちも入れるべきでは？」

となって、かといって、とりとめなく追加していけばいいものでもないし。
メンテコスト上がる and 追加し過ぎたら結局初学者にとってどれが重要なのか？が、(相当工夫して書かない限り)わかりづらくなってデメリット増える、などがあり

kmizu · 2022-09-17T16:24:59Z

@xuwei-k 実はこの辺り、先週のscala_text もくもく会＠Discordでなんとなく決まったことなんで経緯書いておきます：

@i10416 さんからsbtの記述を追加してみてはどうかという提案
@kmizu が「本格的なのはsbt公式ページに任せて、薄い感じで使い方だけ書くのはどうか」という感じで @i10416 さんにアサイン
@i10416 さんがプルリク作成

こんな感じです。で、おっしゃる通り、

何をどのくらい入れるか？

も重要だとは思いますが、深く決めずに見切り発車した面があります。「sbtをインストールする」というページは既にあるわけだし、

build.sbtの基本的な書き方
- scalaVersion, version, name, organizationとか
libraryDependenciesの書き方（追加の仕方）

くらいは書いておいてもこれ以上あんまり変わらないだろうし、いいのかなと思ってます。

ちなみにscala_textもくもく会のログは残ってないんですが、コミュニケーション上問題になるかもなので、次回からGitHubのIssueに残すようにします。

xuwei-k · 2022-09-17T19:08:48Z

あとここに足してない https://github.com/scala-text/scala_text/blob/f8dd77cb517ab43528d354021d39938f8d425367/src/SUMMARY.md

xuwei-k · 2022-09-17T23:15:12Z

ちなみにscala_textもくもく会のログは残ってないんですが、コミュニケーション上問題になるかもなので、次回からGitHubのIssueに残すように

はい。他のissueやpull reqでもそうだけど、完全に自分が当初discord導入した時の懸念したのがそのままになったというか、discordに(毎回 or 結構な頻度で)参加しないと流れがわからないのは、そちらに参加しない人にとってむしろ貢献する障壁が上がるデメリットがあると思うので、最低限は書いて欲しいですね

kmizu · 2022-09-18T15:00:34Z

@xuwei-k 承知しました。最低限、

決まったことと、その経緯
議論になったこと

辺りの一覧は書くようにしますね。

Co-authored-by: kenji yoshida <6b656e6a69@gmail.com>

i10416 · 2022-09-21T17:44:29Z

そもそも根本的に前もどこかで何度か書いたけど、sbt自体は公式ページ参照してもらって、足りないとかわかりずらいなら、そっちを充実させればいい気がするから、ここに追加するのはあまり賛成ではない

これはおおむね同意ですがライブラリの追加方法など基本的なことは書いておいてもいいかな？と思いました.

また、このPRでは1ページ追加して書きましたが適当な場所があるなら既存のページにもう少し簡潔にしようかと思っていますがどうでしょうか.
（文章の流れを壊さずsbtの記述をいい感じに入れられるところが見当たらなかったので質問しました）

src/sbt-usage.md

xuwei-k · 2022-09-22T01:52:22Z

textlintはこういうの100カ所以上？怒られてる

句読点には全角の「、」と「。」を使います。和文の句読点としてピリオド(.)とカンマ(,)を使用しません。 jtf-style/1.2.1.句点(。)と読点(、)
7:19 ✓ error 和文の句読点としてはピリオドを使用しません。 jtf-style/4.1.3.ピリオド(.)、カンマ(,)
9:8 ✓ error 原則として、全角文字と半角文字の間にスペースを入れません。 jtf-style/3.1.1.全角文字と半角文字の間
9:18 ✓ error 半角のかっこ()が使用されています。全角のかっこ（）を使用してください。 jtf-style/4.3.1.丸かっこ（）

i10416 · 2022-09-22T04:22:42Z

textlintはこういうの100カ所以上？怒られてる

すみません. とりあえず書いてみて、フィードバック次第で既存のページのどこかのセクションに追加するか、別のページにするか、そもそも書かないか検討して、書くならその際に清書すればいいかな、と思っていて雑になりました.　このような意図は PRの概要に書いておくべきでしたm(_ _)m

kmizu

@i10416 些細な指摘はどちらでもいいですが、ミスっぽいものだけ直してもらえればOKです。

src/sbt-usage.md

xuwei-k · 2022-09-23T02:04:12Z

あとここに足してない https://github.com/scala-text/scala_text/blob/f8dd77cb517ab43528d354021d39938f8d425367/src/SUMMARY.md

https://github.com/scala-text/scala_text#honkit%E3%81%A7%E7%89%B9%E5%88%A5%E8%A6%96%E3%81%95%E3%82%8C%E3%82%8B%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6

summary: 本のページ遷移情報に利用される
summaryを更新しないとページを追加しても本に反映されないので注意が必要。

src/sbt-usage.md

Co-authored-by: kenji yoshida <6b656e6a69@gmail.com>

kmizu · 2024-02-28T12:04:11Z

こちらいったんcloseします。またopenが必要な場合は別途議論するということで 🙏

draft: add sbt usage page

5c5c317

i10416 requested review from xuwei-k and kmizu as code owners September 16, 2022 14:12

xuwei-k reviewed Sep 16, 2022

View reviewed changes

src/sbt-usage.md Outdated Show resolved Hide resolved

xuwei-k reviewed Sep 16, 2022

View reviewed changes

src/sbt-usage.md Outdated Show resolved Hide resolved

xuwei-k reviewed Sep 16, 2022

View reviewed changes

src/sbt-usage.md Outdated Show resolved Hide resolved

xuwei-k reviewed Sep 16, 2022

View reviewed changes

src/sbt-usage.md Outdated Show resolved Hide resolved

xuwei-k reviewed Sep 16, 2022

View reviewed changes

xuwei-k reviewed Sep 17, 2022

View reviewed changes

src/sbt-usage.md Outdated Show resolved Hide resolved

i10416 and others added 2 commits September 22, 2022 02:31

Update src/sbt-usage.md

603ee44

Co-authored-by: kenji yoshida <6b656e6a69@gmail.com>

Update src/sbt-usage.md

6e54b85

i10416 commented Sep 21, 2022

View reviewed changes

src/sbt-usage.md Outdated Show resolved Hide resolved

i10416 commented Sep 21, 2022

View reviewed changes

src/sbt-usage.md Outdated Show resolved Hide resolved

i10416 commented Sep 21, 2022

View reviewed changes

src/sbt-usage.md Outdated Show resolved Hide resolved

Apply suggestions from code review

1d25063

i10416 added 3 commits September 22, 2022 13:11

chore: fmt

df3a2e1

chore: rm local config

d8e57ef

improve: mention official doc

f5f0556

i10416 force-pushed the improve-refer-to-sbt-usage branch from fdb908f to 5a0ed96 Compare September 22, 2022 04:43

fix: address textlint warnings

2b1e100

i10416 force-pushed the improve-refer-to-sbt-usage branch from 5a0ed96 to 2b1e100 Compare September 22, 2022 05:18

Merge branch 'master' into improve-refer-to-sbt-usage

6754257

kmizu requested changes Sep 22, 2022

View reviewed changes

xuwei-k reviewed Sep 23, 2022

View reviewed changes

src/sbt-usage.md Outdated Show resolved Hide resolved

xuwei-k reviewed Sep 23, 2022

View reviewed changes

src/sbt-usage.md Outdated Show resolved Hide resolved

xuwei-k reviewed Sep 23, 2022

View reviewed changes

src/sbt-usage.md Outdated Show resolved Hide resolved

xuwei-k reviewed Sep 23, 2022

View reviewed changes

src/sbt-usage.md Outdated Show resolved Hide resolved

i10416 and others added 5 commits September 23, 2022 17:22

Update src/sbt-usage.md

5732284

Co-authored-by: kenji yoshida <6b656e6a69@gmail.com>

Update src/sbt-usage.md

45614ab

Co-authored-by: kenji yoshida <6b656e6a69@gmail.com>

Update src/sbt-usage.md

023adab

Co-authored-by: kenji yoshida <6b656e6a69@gmail.com>

Update src/sbt-usage.md

5aee253

Co-authored-by: kenji yoshida <6b656e6a69@gmail.com>

Merge branch 'master' into improve-refer-to-sbt-usage

17c663d

kmizu mentioned this pull request Oct 10, 2022

scala_textもくもく会@Discord議事録 #1027

Open

kmizu closed this Feb 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

draft: add sbt usage page #1016

draft: add sbt usage page #1016

i10416 commented Sep 16, 2022 •

edited

Loading

xuwei-k commented Sep 16, 2022

xuwei-k Sep 16, 2022

kmizu Sep 22, 2022

xuwei-k commented Sep 16, 2022

xuwei-k Sep 16, 2022

xuwei-k Sep 17, 2022

i10416 Sep 22, 2022

kmizu Sep 22, 2022

xuwei-k Sep 16, 2022

xuwei-k Sep 17, 2022

i10416 Sep 21, 2022

i10416 Sep 22, 2022

kmizu Sep 22, 2022

xuwei-k Sep 16, 2022

i10416 Sep 21, 2022

kmizu Sep 22, 2022

xuwei-k Sep 16, 2022 •

edited

Loading

kmizu Sep 22, 2022

xuwei-k Sep 16, 2022

kmizu Sep 22, 2022

xuwei-k commented Sep 16, 2022

xuwei-k Sep 17, 2022

i10416 Sep 22, 2022

xuwei-k commented Sep 17, 2022

kmizu commented Sep 17, 2022 •

edited

Loading

xuwei-k commented Sep 17, 2022

xuwei-k commented Sep 17, 2022

kmizu commented Sep 18, 2022 •

edited

Loading

i10416 commented Sep 21, 2022

xuwei-k commented Sep 22, 2022

i10416 commented Sep 22, 2022 •

edited

Loading

kmizu left a comment

xuwei-k commented Sep 23, 2022

kmizu commented Feb 28, 2024 •

edited

Loading


		このように書けば `src/main/scala` 以下にある Scala ファイルから下のようにライブラリをインポートして利用できます.

		```scala

		他の Scala アプリケーションやライブラリから利用するライブラリを書く際は、しばしば複数の Scala バージョン向けに
		ライブラリをビルドします.

draft: add sbt usage page #1016

draft: add sbt usage page #1016

Conversation

i10416 commented Sep 16, 2022 • edited Loading

xuwei-k commented Sep 16, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xuwei-k commented Sep 16, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xuwei-k Sep 16, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xuwei-k commented Sep 16, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xuwei-k commented Sep 17, 2022

kmizu commented Sep 17, 2022 • edited Loading

xuwei-k commented Sep 17, 2022

xuwei-k commented Sep 17, 2022

kmizu commented Sep 18, 2022 • edited Loading

i10416 commented Sep 21, 2022

xuwei-k commented Sep 22, 2022

i10416 commented Sep 22, 2022 • edited Loading

kmizu left a comment

Choose a reason for hiding this comment

xuwei-k commented Sep 23, 2022

kmizu commented Feb 28, 2024 • edited Loading

i10416 commented Sep 16, 2022 •

edited

Loading

xuwei-k Sep 16, 2022 •

edited

Loading

kmizu commented Sep 17, 2022 •

edited

Loading

kmizu commented Sep 18, 2022 •

edited

Loading

i10416 commented Sep 22, 2022 •

edited

Loading

kmizu commented Feb 28, 2024 •

edited

Loading