Google Git
Sign in
go / website / 769f579886d06a98fe8ac726f7ab71fe68104b85
commit769f579886d06a98fe8ac726f7ab71fe68104b85[log] [tgz]
authorJamal Carvalho <jamal@golang.org>Fri Jan 07 19:26:13 2022 +0000
committerJamal Carvalho <jamalcarvalho@google.com>Mon Jan 10 16:34:55 2022 +0000
tree69bfaf1f19b1af820c8111636f0d476c5342bfee
parent5dfff35f770e3374da4bcfcb5f2727562c39b02d [diff]
website: add linter tooling and documentation

- Added package.json and lockfile
- Added npm and npx scripts
- Updated README

Change-Id: Ib01c09d943bb607c51544189d3dbbf1c42444921
Reviewed-on: https://go-review.googlesource.com/c/website/+/376301
Run-TryBot: Jamal Carvalho <jamal@golang.org>
Trust: Jamal Carvalho <jamalcarvalho@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Alex Rakoczy <alex@golang.org>
5 files changed
tree: 69bfaf1f19b1af820c8111636f0d476c5342bfee
  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. LICENSE
  19. npm
  20. npx
  21. package-lock.json
  22. package.json
  23. PATENTS
  24. README.md
  25. 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">

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.