WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit 59df888

Browse files
authored
Merge pull request #1 from YuheiFUJITA/feat/init
feat: init
2 parents 8d27fff + b36dfb3 commit 59df888

File tree

7 files changed

+1294
-22
lines changed

7 files changed

+1294
-22
lines changed

.clasp.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"scriptId": "1UBMWBCH5BioOcDwD4eyQfAqLQRBJ6HBOGfyoMwiEC3hDsVKBsPS1Ogfb",
3+
"rootDir": "src",
4+
"fileExtension": "ts"
5+
}

.eslintrc.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
env:
2+
browser: true
3+
es2021: true
4+
extends:
5+
- google
6+
parser: '@typescript-eslint/parser'
7+
parserOptions:
8+
ecmaVersion: 12
9+
sourceType: module
10+
plugins:
11+
- '@typescript-eslint'
12+
rules: {}

LICENSE

Lines changed: 0 additions & 21 deletions
This file was deleted.

README.md

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,60 @@
11
# template-gas
2-
Template for Google Apps Script with TypeScript
2+
3+
## このテンプレートについて
4+
このテンプレートは、Google Apps Scriptについて以下のことを行うことができます。
5+
6+
* TypeScriptによるコーディング
7+
* ローカル上での開発
8+
9+
## 使い方
10+
11+
### 環境構築
12+
このテンプレートを使うには、 [`clasp`](https://github.com/google/clasp) が必要になります。
13+
14+
インストールしていない場合、 以下のコマンドからインストールしてください。
15+
16+
また、 [設定](https://script.google.com/home/usersettings) よりGoogle Apps Script APIを有効にする必要があります。
17+
18+
```
19+
$ npm install -g @google/clasp
20+
$ clasp login
21+
```
22+
23+
### プロジェクトのセットアップ
24+
まず、 `.clasp.json``scriptId` に対象のGASのスクリプトIDを設定してください。
25+
26+
スクリプトIDはGoogleドライブから目的のGASを開き、 `ファイル > プロジェクトのプロパティ` から表示される `スクリプト ID` から確認できます。
27+
28+
既存のソースコードがある場合、以下のコマンドでローカルに `pull` できます。
29+
30+
```
31+
$ clasp pull
32+
```
33+
34+
### ソースコードのアップロード
35+
ローカルでコーディングしたソースコードは、以下のコマンドを実行することでGASプロジェクトに `push` できます。
36+
37+
```
38+
$ clasp push
39+
```
40+
41+
## 各ファイル/ディレクトリについて
42+
43+
### `src`
44+
このディレクトリ配下のファイルが `clasp push` の対象になります。
45+
46+
GASのソースコードはこのディレクトリ内に配置してください。
47+
48+
変更したい場合は、 `.clasp.json``rootDir` を変更してください。
49+
50+
### `.clasp.json`
51+
`clasp` に関する設定ファイルです。
52+
53+
詳しくは [こちら](https://github.com/google/clasp#project-settings-file-claspjson) を参照してください。
54+
55+
56+
## 開発時の注意
57+
`clasp` には `push``pull` といった `git` に似たコマンドがありますが、 `clasp` 自体に `git` のようなバージョン管理機能はありません。
58+
`clasp push``clasp pull` は、純粋にローカルからGASプロジェクト(もしくはその逆)への上書きを行います。
59+
60+
また、 TypeScriptでコーディングされたGASを `clasp push` すると、自動的に `.gs` にトランスパイルされます。そのため、 `clasp push` したあとに `clasp pull` してしまうと、トランスパイル後のファイルでローカルのファイルが上書きされてしまいます。

0 commit comments

Comments
 (0)