playframework / playframework/play-samples

Format each sample project

Open
#118 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
554
Forks
548
Avg merge
1d 11h
Merged PRs (30d)
57

Description

We could add something like https://github.com/akka/akka-guide/blob/54a81ce729ef07e1f9b97f0f15a4ff7d60e4d0ed/scripts/format-all.sh and even remove the separate Travis jobs.
WDYT?

Code, click to exapnd
#!/usr/bin/env bash

declare -r tutorial_root="docs-source/docs/modules/microservices-tutorial/examples"

find ${tutorial_root} -name .scalafmt.conf |
while read result
do
	pushd $(dirname $result)
	sbt scalafmtAll
	popd
done

find ${tutorial_root} -name pom.xml |
while read result
do
	pushd $(dirname $result)
	mvn spotless:apply
	popd
done

Originally posted by @ennru in https://github.com/playframework/play-samples/pull/116#discussion_r518005653

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the sample projects under docs-source/docs/modules/microservices-tutorial/examples and the separate Travis jobs, then compare the proposed format-all.sh approach with the referenced akka-guide script. Done means each sample is formatted through the appropriate scalafmt or Spotless command and redundant Travis jobs are removed.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala, shell
Domain
build-system, ci-cd
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.