Closed Bug 1648118 Opened 5 years ago Closed 4 years ago

Consider changing lint and fmt make commands to match the pattern of the other commands

Categories

(Data Platform and Tools :: Glean: SDK, task, P1)

Product:
Data Platform and Tools
Component:
Glean: SDK
Type:
task

Tracking

(Not tracked)

Status:
RESOLVED FIXED

People

(Reporter: brizental, Assigned: chinyingli.alice, Mentored)

Details

Attachments

(1 file)

Link to GitHub pull-request: https://github.com/mozilla/glean/pull/1526
42 bytes, text/x-github-pull-request
Details | Review

Most of the commands in our Makefile are following a pattern of <action>-<language>, for example, the test commands are all test-kotlin, test-swift, test-python, etc.

It is counter intuitive to me that the formatting and linting commands don't follow this pattern. I propose we rename these commands to lint-<language> and fmt-<language>.

Love this, +1.

Priority: -- → P3
Whiteboard: [telemetry:glean-rs:m?]
Whiteboard: [telemetry:glean-rs:m?] → [telemetry:glean-rs:backlog]
Priority: P3 → P4

Is this currently a valid issue? I would like to submit a small patch for this.

Hey Jan-Erik, do we still want this?

Flags: needinfo?(jrediger)

Sounds like a good idea.

  • Remove the lint and fmt task.
  • Rename the tasks:
    • clippy -> lint-rust
    • rustfmt -> fmt-rust
    • ktlint -> lint-kotlin
    • swiftlint -> lint-swift
    • pythonlint -> lint-python
    • pythonfmt -> fmt-python

Adjust the .PHONY setting accordingly. Also please check if any of these tasks is used in .circleci/config.yaml and adjust accordingly.

Assignee: nobody → chinyingli.alice
Mentor: jrediger
Flags: needinfo?(jrediger)
Priority: P4 → P1
Whiteboard: [telemetry:glean-rs:backlog]
Status: NEW → RESOLVED
Closed: 4 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Creator:
Created:
Updated:
Size: