flatfisher / cloud-functions-typescript-template

TypeScript template for Google Cloud Functions

cloud-functions-typescript-template

cloud-functions-typescript-template is a base project of Google Cloud Functions using TypeScript. This project contains tools and configuration files that are likely to be used frequently (eg Test tool and Lint) from the beginning. Please feel free to submit Pull Request or Issue if there are recommended tools and configuration files.

Prerequisites

npm, tsc, gcloud commands installed

(alpha) Installation

$ npm install google-cloud-functions-typescript

$ npx create-project your-directory

Edit config in package.json

"config": {
  "function_name": "Your function name, it must match the name of export function in index.ts.",
  "region": "europe-west1 or us-east1 or us-central1 or asia-northeast1",
  "gcp_project": "Your GCP project name",
  "runtime": "nodejs8"
}

Lint

$ npm run lint

Build

It makes a Node.js project into functions/src/

$ npm run build

Test

$ npm run test

Deploy

$ npm run deploy --prefix functions/src/

Contribution

Feel free to create a pull request:) Recommended settings, bug fixes, descriptions and more!

cloud-functions-typescript-template's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Warning

These dependencies are deprecated:

Datasource	Name	Replacement PR?
npm	@types/chai-http
npm	@types/moment
npm	tslint

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• Update actions/cache action to v4
• Update actions/checkout action to v4
• Update actions/setup-node action to v4
• Update dependency chai-http to v5
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency express to v4.19.2 [SECURITY]
• Update dependency @types/express to v4.17.21
• Update dependency npm-run-all2 to v5.0.2
• Update dependency @types/node to v18.19.39
• Update dependency chai to v4.4.1 (chai, @types/chai)
• Update dependency chai-http to v4.4.0
• Update dependency @types/node to v20
• Update dependency chai to v5
• Update dependency npm-run-all2 to v6
• Update dependency rimraf to v5
• Update dependency typescript to v5
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• Update dependency mocha to v10 (mocha, @types/mocha)

Detected dependencies

github-actions

.github/workflows/nodejs.yml

• actions/checkout v2
• actions/setup-node v1
• actions/cache v2

npm

package.json

• @types/chai 4.3.4
• @types/chai-http 4.2.0
• @types/express 4.17.17
• @types/mocha 9.1.1
• @types/moment 2.13.0
• @types/node 18.14.0
• chai 4.3.7
• chai-http 4.3.0
• copyfiles 2.4.1
• express 4.18.2
• mocha 9.2.2
• npm-run-all2 5.0.0
• rimraf 3.0.2
• tslint 6.1.3
• typescript 4.9.5

---

• Check this box to trigger a request for Renovate to run again on this repository

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

npm run test not woeking

I suppose the test and src folders are meant to be inside /functions folder.