Google Git
Sign in
go / website / 6f4aa0ee4cb14a8fb4fe9255943fa75ede57cacc
commit6f4aa0ee4cb14a8fb4fe9255943fa75ede57cacc[log] [tgz]
authorJamal Carvalho <jamal@golang.org>Tue Jan 11 17:56:41 2022 +0000
committerJamal Carvalho <jamalcarvalho@google.com>Tue Jan 11 22:46:10 2022 +0000
treef07c0e7bfdc4ba88647953e27df2576d35fae447
parent60e69eecf230205ddad248acba3f07f09ab564f0 [diff]
website: add support for JS/TS unit testing

Change-Id: I8bb35b7183c07c44c5e5da8dc2f2c15cc38ea64b
Reviewed-on: https://go-review.googlesource.com/c/website/+/377734
Run-TryBot: Jamal Carvalho <jamal@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Alex Rakoczy <alex@golang.org>
Trust: Jamal Carvalho <jamalcarvalho@google.com>
8 files changed
tree: f07c0e7bfdc4ba88647953e27df2576d35fae447
  1. _content/
  2. _later/
  3. cmd/
  4. internal/
  5. tour/
  6. .eslintrc.yaml
  7. .gitattributes
  8. .prettierrc.yaml
  9. .stylelintrc.yaml
  10. AUTHORS
  11. codereview.cfg
  12. content.go
  13. CONTRIBUTING.md
  14. CONTRIBUTORS
  15. go-app-deploy.sh
  16. go.mod
  17. go.sum
  18. jest-transform.cjs
  19. LICENSE
  20. npm
  21. npx
  22. package-lock.json
  23. package.json
  24. PATENTS
  25. README.md
  26. tsconfig.json
README.md

Go website

Go Reference

This repo holds content and serving programs for the go.dev and golang.org web sites.

Content is in _content/ (go.dev) and tour/ (go.dev/tour). Server code is in cmd/ and internal/.

To run the combined go.dev+golang.org server to preview local content changes, use:

go run ./cmd/golangorg

The supporting programs cmd/admingolangorg and cmd/googlegolangorg are the servers for admin.golang.org and google.golang.org. (They do not use the _content/ directories.)

Each command directory has its own README.md explaining deployment.

JS/TS/CSS Formatting

This repository uses eslint to format JS and TS files, and stylelint to format CSS files.

See also:

It is encouraged that all JS, TS, and CSS code be run through formatters before submitting a change. However, it is not a strict requirement enforced by CI.

Installing npm Dependencies:

  1. Install docker
  2. Create a .gitignore file at repo root
  3. Add .gitignore and node_modules to .gitignore
  4. Run ./npm install

Run ESlint

./npx eslint [options] [file] [dir]

Run Stylelint

./npx stylelint [input] [options]

TypeScript Support

TypeScript files served from _content are transformed into JavaScript. Reference .ts files in html templates as module code.

<script type="module" src="/ts/filename.ts">

Write unit tests for TypeScript code using the jest testing framework.

Run Jest

./npx jest [TestPathPattern]

Deploying

Each time a CL is reviewed and submitted, the code is deployed to App Engine. See cmd/golangorg/README.md for details.

Report Issues / Send Patches

This repository uses Gerrit for code changes. To learn how to submit changes to this repository, see https://go.dev/doc/contribute.

The main issue tracker for the website repository is located at https://github.com/golang/go/issues. Prefix your issue with “x/website:” in the subject line, so it is easy to find.