loadsys / loadsys/loadsys_codesniffer

.editorconfig to prevent stripping trailing space, adding final newline in snifftests/files/.

Open
#44 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help-wanted
Dominant language
PHP
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

One of the gotchas of working on the "bad" sample files is that sometimes your editor is actively trying to help you from making style mistakes. While this is a good thing in any actual project, it's problematic when working on the sample files that should intentionally break our standard.

An `.editorconfig` file should be added to this project that disables options such as "add final newline" and "trim trailing line whitespace" within the `snifftests/files/` folder. This will make it easier to work on the files without accidentally modifying them to no longer fail a specific rule.

Contributor guide

No contributing guide indexed for this repository

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

Add an .editorconfig file covering snifftests/files/ and inspect the existing sample-file layout there first. Configure the requested exceptions for final newlines and trailing whitespace, then verify that editor settings preserve those intentional formatting violations.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
tooling
Issue type
Feature
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.