Skip to content

Commit cbad747

Browse files
authored
Add typos config and fix grammatical issues (#64)
* Add typos config to suppress false positive in test fixture data `#pulic_api:` in test/unit/privacy/checker_test.rb is intentional test data verifying that a misspelled sigil is rejected as invalid. Suppress the false positive with a _typos.toml extend-words entry. * Fix grammatical issues in README - Fix missing words in folder_privacy checker description: "allows packages to their sibling packs" -> "allows packages to be private to their sibling packs" - Remove duplicate word: "way of of defining" -> "way of defining" * Remove _typos.toml
1 parent bc6a4cc commit cbad747

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Currently, it ships the following checkers to help improve the boundaries between packages. These checkers are:
66
- A `privacy` checker that ensures other packages are using your package's public API
77
- A `visibility` checker that allows packages to be private except to an explicit group of other packages.
8-
- A `folder_privacy` checker that allows packages to their sibling packs and parent pack (to be used in an application that uses folder packs)
8+
- A `folder_privacy` checker that allows packages to be private to their sibling packs and parent pack (to be used in an application that uses folder packs)
99
- A `layer` (formerly `architecture`) checker that allows packages to specify their "layer" and ensures they cannot use packages from higher layers
1010

1111
## Installation
@@ -63,7 +63,7 @@ public_path: my/custom/path/
6363
### Defining public constants through sigil
6464

6565
> [!WARNING]
66-
> This way of of defining the public API of a package should be considered WIP. It is not supported by all tooling in the RubyAtScale ecosystem, as @alexevanczuk pointed out in a [comment on the PR](https://github.com/rubyatscale/packwerk-extensions/pull/35#discussion_r1334331797):
66+
> This way of defining the public API of a package should be considered WIP. It is not supported by all tooling in the RubyAtScale ecosystem, as @alexevanczuk pointed out in a [comment on the PR](https://github.com/rubyatscale/packwerk-extensions/pull/35#discussion_r1334331797):
6767
>
6868
> There are a couple of other places that will require changes related to this sigil. Namely, everything that is coupled to the public folder implementation of privacy.
6969
>

0 commit comments

Comments
 (0)