satayダウンロードsatayソースコードのダウンロード

satay

その他のカテゴリー

1.0.0

ダウンロード

サテ

静的サイトをAWS S3にアップロードするためのユーティリティ。

使用法

CLIを使用します

satayグローバルにインストールする：
```
$ npm install -g satay
```

構成ファイルを作成します。

satay.config.js

 module . exports = {
  bucket : 'jameslnewell.me' ,

  groups : [
    {
      source : './static' ,
      include : / .html$ /
    } ,

    //cache finger-printed assets for up to 1 year
    {
      source : './static' ,
      exclude : / .html$ / ,
      params : {
        CacheControl : `max-age= ${ 60 * 60 * 24 * 365.25 } , public`
      }
    }
  ]
} ;

AWS資格情報を構成します
satayを実行します
```
$ satay
```

APIを使用します

satayローカルにインストールする：
```
$ npm install --save-dev satay
```

スクリプトファイルを作成します。

upload.js

 import satay from 'satay' ;

satay (
  'jameslnewell.me' ,
  [
    {
      source : './static' ,
      include : / .html$ /
    } ,

    //cache finger-printed assets for up to 1 year
    {
      source : './static' ,
      exclude : / .html$ / ,
      params : {
        CacheControl : `max-age= ${ 60 * 60 * 24 * 365.25 } , public`
      }
    }
  ] ,
  {
    shouldUploadUnmodifiedObjects : true
  }
) ;

AWS資格情報を構成します
upload.js実行します
```
$ node upload.js
```

cli

$ satay --config=satay.config.js

フラグ：

--configオプション。構成ファイル名。現在の作業ディレクトリのsatay.config.jsにデフォルト。

構成

プロパティ：

bucket -オプション。 string 。バケツの名前。
groups -必須。ファイルグループのarray 。
- source -オプション。 string 。検索されるディレクトリ。デフォルトはprocess.cwd()になります。
- include -オプション。 RegExpまたはfunction 。どのファイルが含まれているかをフィルタリングするための正規表現または関数。
- exclude -オプション。 RegExpまたはfunction 。どのファイルが除外されるかをフィルタリングするための正規表現または関数。
- prefix -オプション。 string 。オブジェクトキーに加えられるプレフィックス。デフォルトは""になります。
- params -オプション。 object 。 S3.putObject()に渡す追加のパラメーター。デフォルトは{ContentType: mime.lookup(filename), ACL: 'public-read'}になります。
policy -オプション。 object 。 AWSポリシー。デフォルトは、すべてのファイルのパブリック読み取りアクセスになります。
website -オプション。 object 。 AWS Webサイトの構成。 index.htmlデフォルトのIndexDocumentとして使用し、 404.htmlデフォルトのErrorDocumentを使用します。
shouldCreateBucketオプションです。 boolean 。バケットが存在しない場合に作成すべきかどうか。
shouldConfigureBucketオプション。 boolean 。バケットが存在しない場合、バケットを公開ウェブサイトとして構成すべきかどうか。
shouldUploadUnmodifiedObjectsオプション。 boolean 。バケット内のファイルと同じであっても、ディスク上の未修飾ファイルをアップロードする必要があるかどうか。
shouldDeleteDeletedObjects -optional 。 boolean 。バケット内のオブジェクトがディスクから削除されたときに削除する必要があるかどうか。

API

 satay ( bucket : String , groups : Array < Group > , options : Object ) : Promise

パラメーター：

bucket -必須。 string 。バケツの名前。
groups -必須。ファイルグループのarray 。
- source -オプション。 string 。検索されるディレクトリ。デフォルトはprocess.cwd()になります。
- include -オプション。 RegExpまたはfunction 。どのファイルが含まれているかをフィルタリングするための正規表現または関数。
- exclude -オプション。 RegExpまたはfunction 。どのファイルが除外されるかをフィルタリングするための正規表現または関数。
- prefix -オプション。 string 。オブジェクトキーに加えられるプレフィックス。デフォルトは""になります。
- params -オプション。 object 。 S3.putObject()に渡す追加のパラメーター。デフォルトは{ContentType: mime.lookup(filename), ACL: 'public-read'}になります。
options -オプション。 object 。追加のオプション。
- policy -オプション。 object 。 AWSポリシー。デフォルトは、すべてのファイルのパブリック読み取りアクセスになります。
- website -オプション。 object 。 AWS Webサイトの構成。 index.htmlデフォルトのIndexDocumentとして使用し、 404.htmlデフォルトのErrorDocumentを使用します。
- shouldCreateBucketオプションです。 boolean 。バケットが存在しない場合に作成すべきかどうか。
- shouldConfigureBucketオプション。 boolean 。バケットが存在しない場合、バケットを公開ウェブサイトとして構成すべきかどうか。
- shouldUploadUnmodifiedObjectsオプション。 boolean 。バケット内のファイルと同じであっても、ディスク上の未修飾ファイルをアップロードする必要があるかどうか。
- shouldDeleteDeletedObjects -optional 。 boolean 。バケット内のオブジェクトがディスクから削除されたときに削除する必要があるかどうか。