modernization of proselint #1361

orgua · 2024-01-05T23:46:58Z

I hereby make use of my copyright and revoke the permission to use any of my code (commits & branches). Good thing is that nothing has been merged yet.
I'm licensing it under a private license that specifically forbids usage in proselint.

Bumps [ruby/setup-ruby](https://github.com/ruby/setup-ruby) from 1.95.0 to 1.163.0. - [Release notes](https://github.com/ruby/setup-ruby/releases) - [Commits](ruby/setup-ruby@v1.95.0...v1.163.0) --- updated-dependencies: - dependency-name: ruby/setup-ruby dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 2.1.0 to 3.1.4. - [Release notes](https://github.com/codecov/codecov-action/releases) - [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md) - [Commits](codecov/codecov-action@v2.1.0...v3.1.4) --- updated-dependencies: - dependency-name: codecov/codecov-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps [actions/setup-python](https://github.com/actions/setup-python) from 2 to 5. - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](actions/setup-python@v2...v5) --- updated-dependencies: - dependency-name: actions/setup-python dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps [actions/cache](https://github.com/actions/cache) from 2 to 3. - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](actions/cache@v2...v3) --- updated-dependencies: - dependency-name: actions/cache dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps [pytest](https://github.com/pytest-dev/pytest) from 6.2.5 to 7.4.3. - [Release notes](https://github.com/pytest-dev/pytest/releases) - [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst) - [Commits](pytest-dev/pytest@6.2.5...7.4.3) --- updated-dependencies: - dependency-name: pytest dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]>

…che-3 chore(deps): bump actions/cache from 2 to 3

…tup-python-5 chore(deps): bump actions/setup-python from 2 to 5

chore(deps-dev): bump pytest from 6.2.5 to 7.4.3

Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 4. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v2...v4) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]>

…eckout-4 chore(deps): bump actions/checkout from 2 to 4

…-ruby-1.163.0 chore(deps): bump ruby/setup-ruby from 1.95.0 to 1.163.0

…decov-action-3.1.4 chore(deps): bump codecov/codecov-action from 2.1.0 to 3.1.4

output was checked for errors

Nytelife26 · 2024-01-25T01:21:23Z

I have managed to rebase everything successfully, and get pytest to run. A new problem is that TypeAlias is not available on Python versions prior to 3.10. I am not sure how you would like to proceed with that.

orgua · 2024-01-25T08:39:16Z

.ruff.toml

@@ -1,5 +1,5 @@

-#line-length = 90
+line-length = 80


can we at least compromise on 88 chars, as it is widely used by black? 80 chars are a relic from the 80's a bit of from the current sweetspot.

88 is a non-standard line length. Sure, 80 characters is an old requirement, but I find you can pretty much always achieve what you need to and it forces you to keep things clean.

It's personal preference, I suppose, but since I refactored proselint the first time it has used 80 character line lengths.

black is the current standard (as it is widely used) in python world - even ruff adopted it and formats the same :)
but ok

Black's completely arbitrary, sarcastically-justified 88-character line length is one of its more controversial "opinions", though.

Particularly as it violates PEP8 — an actual standard, not (at best) a "de facto standard" like Black. (Though PEP8 admittedly did itself no favors by specifying 79 characters instead of 80, something that was met with almost immediate, near-universal rejection.)

IIRC line length was also the very first configuration option Black gained, once its original vision of being completely non-configurable collided headfirst with reality.

proselint/checks/__init__.py

proselint/score.py

scripts_web/app.py

tests/checks/test_misc_but.py

orgua · 2024-01-25T08:52:08Z

proselint/checks/__init__.py

-    if level == "sentence":
-        pass
-    elif level == "paragraph":
+    if level in {"sentence", "paragraph"}:


thats really wrong, as these are placeholders for custom sub-functionality. not from me, but it had a reason to be like that.

That was a lint suggestion, and it checks out to me. I believe the plan was to add some eventual logic, but I see no reason not to tidy up until then.

orgua · 2024-01-25T09:22:32Z

.ruff.toml

@@ -1,5 +1,5 @@

-#line-length = 90
+line-length = 80


black is the current standard (as it is widely used) in python world - even ruff adopted it and formats the same :)
but ok

proselint/checks/__init__.py

proselint/checks/misc/capitalization.py

Co-authored-by: Tyler J Russell <[email protected]>

orgua · 2024-01-25T10:39:01Z

I have managed to rebase everything successfully, and get pytest to run. A new problem is that TypeAlias is not available on Python versions prior to 3.10. I am not sure how you would like to proceed with that.

Already replaced one of the typeAlias with a named tuple, will also extend the second as it's cleaner.

That latest force-push really messes up a lot - I had to do a rebase on my current main (this PR) and hoped /dev would be smoother, but its a hot mess. I have to handle 80+ commits indiviually, deleted files are reappearing randomly.
Update: I stopped the rebase and did a merge commit. The PR seems to work - still WIP. Is it ok for you to review it there? I would propose to:

bring the /dev-addition to a working state
update proselint/main next as handling this gets more and more complicated
after that we can talk about the next steps. A bunch of issues can be closed. Do you wanna do a release inbetween or change more core-structures and merge in PRs?

Nytelife26 · 2024-01-25T11:22:28Z

Already replaced one of the typeAlias with a named tuple, will also extend the second as it's cleaner.

That's good news, thank you.

That latest force-push really messes up a lot - I had to do a rebase on my current main (this PR) and hoped /dev would be smoother, but its a hot mess. I have to handle 80+ commits indiviually, deleted files are reappearing randomly.

I know it's not ideal, and I apologise sincerely for that. Thank you for sticking with me and continuing to work on it.

Update: I stopped the rebase and did a merge commit. The PR seems to work - still WIP. Is it ok for you to review it there?

Of course. I'll take a look shortly.

update proselint/main next as handling this gets more and more complicated

To make this easier, it might be possible to split this into multiple more atomic PRs. I am not sure how you would like to group them, but that would be my suggestion at this stage. I am of course okay with proceeding to review these in whatever structure you like, that's just a comment from my experience.

after that we can talk about the next steps. A bunch of issues can be closed. Do you wanna do a release inbetween or change more core-structures and merge in PRs?

I would like to at least make progress on the existing PRs around refactoring the configuration system and such, but it might be better to release most of these changes first. Having too many breaking changes in one release could prove hard for people to keep up with. The userbase is, to my knowledge, already dwindling from its former state, so driving more people out would not be ideal.

orgua · 2024-01-25T11:43:00Z

Allright. Don't know what PR-splitting brings, but OK.
You are right - config needs a major overhaul, same for the check-structure. I already opened two issues to collect ideas and coordinate the effort to put it on a future-proof foundation.

reference:

Nytelife26 · 2024-02-04T13:34:26Z

I am working on the check categories. I have some basic ideas for now, but more is to follow later.

Nytelife26 · 2024-02-18T12:59:10Z

.ruff.toml

+[lint.isort]
+force-single-line = true


Suggested change

[lint.isort]

force-single-line = true

I think this should be removed. It makes imports unwieldy.

Nytelife26 · 2024-02-18T13:17:45Z

proselint/checks/__init__.py

+###############################################################################
+# Check-Interface used by linter ##############################################
+###############################################################################


I find large block comments like this to be ugly, so any other method of separation would be preferred.

Nytelife26 · 2024-02-18T15:52:53Z

As a follow-up, you were right. Splitting this PR up would be a nightmare. It would be better to proceed with bringing in your dev branch changes, tidy up the commits here, and then merge this before we work on the other proposals.

Nytelife26 · 2024-05-13T16:20:19Z

note for myself: it would be useful to consider the discussion in #1369 as part of this, or maybe as a later change.

arostkowycz15 and others added 30 commits April 17, 2023 18:45

added check for punctuation spacing. Issue #1342

140b3e0

Added clichés from Nigel Rees' book

451801f

Tests for Nigel's clichés

67be7fc

fix file endings and remove not needed spaces

9db9d31

raise min py-version to 3.8 and remove future

8defcc4

update deps

237ff5e

py: add commas

98ce3d2

clean imports

9083fef

lint code

623d684

fix programming error

f7d62d8

Merge pull request #5 from orgua/dependabot/github_actions/actions/ca…

0dc599c

…che-3 chore(deps): bump actions/cache from 2 to 3

Merge pull request #4 from orgua/dependabot/github_actions/actions/se…

d1ec014

…tup-python-5 chore(deps): bump actions/setup-python from 2 to 5

Merge pull request #6 from orgua/dependabot/pip/pytest-7.4.3

f3ab5cc

chore(deps-dev): bump pytest from 6.2.5 to 7.4.3

Merge pull request #2 from orgua/dependabot/github_actions/actions/ch…

53fe09f

…eckout-4 chore(deps): bump actions/checkout from 2 to 4

Merge pull request #1 from orgua/dependabot/github_actions/ruby/setup…

f28b461

…-ruby-1.163.0 chore(deps): bump ruby/setup-ruby from 1.95.0 to 1.163.0

Merge pull request #3 from orgua/dependabot/github_actions/codecov/co…

2ef0a38

…decov-action-3.1.4 chore(deps): bump codecov/codecov-action from 2.1.0 to 3.1.4

do not pin package-versions if not needed

4aaeea6

clean up usage of paths

62cbc93

remove legacy-code

873014f

avoid shadowing a Python builtins

dbae823

sort imports

1e39e4d

add typehinting

b2ab749

format with black-style, ruff

b24f5b1

output was checked for errors

add proper logging capability

21947b0

orgua and others added 4 commits January 25, 2024 00:56

fix unittests and lint

a60cc86

bump version

84a40ab

ci(lint-test): fix pytest

b3ebed3

chore: fix merge differences

90d610f

Nytelife26 added 5 commits January 25, 2024 01:47

chore: resolve rebase issues

2104094

chore(deps): add ruff

64bb526

lint: fix ruff suggestions

fc5e10a

ci(lint-test): lint with ruff

30f1972

chore: fix lint issues

cefb7a3

orgua commented Jan 25, 2024

View reviewed changes

proselint/checks/__init__.py Outdated Show resolved Hide resolved

proselint/score.py Show resolved Hide resolved

scripts_web/app.py Outdated Show resolved Hide resolved

tests/checks/test_misc_but.py Show resolved Hide resolved

Merge branch 'main' of https://github.com/orgua/proselint-modernized

c1cc4db

orgua commented Jan 25, 2024

View reviewed changes

orgua and others added 3 commits January 25, 2024 11:21

Update tests/check.py

ee7dbf4

Co-authored-by: Tyler J Russell <[email protected]>

implement comments

fa9b0cd

Merge branch 'main' of https://github.com/orgua/proselint-modernized

eb414d1

Nytelife26 mentioned this pull request Feb 9, 2024

Updated Release #1366

Closed

Nytelife26 reviewed Feb 18, 2024

View reviewed changes

Nytelife26 mentioned this pull request Apr 23, 2024

Ignored check names mismatched #1341

Open

Nytelife26 added this to the 1.0.0 milestone Apr 23, 2024

Nytelife26 mentioned this pull request May 13, 2024

refactor: modernisation of proselint #1371

Draft

orgua mentioned this pull request May 16, 2024

Update er_or.py - remove redundant 'promoter'. #1372

Open

orgua closed this by deleting the head repository May 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

modernization of proselint #1361

modernization of proselint #1361

orgua commented Jan 5, 2024 •

edited

Loading

Nytelife26 commented Jan 25, 2024

orgua Jan 25, 2024

Nytelife26 Jan 25, 2024

orgua Jan 25, 2024

ferdnyc May 8, 2024 •

edited

Loading

orgua Jan 25, 2024

Nytelife26 Jan 25, 2024

orgua Jan 25, 2024

orgua commented Jan 25, 2024 •

edited

Loading

Nytelife26 commented Jan 25, 2024

orgua commented Jan 25, 2024

Nytelife26 commented Feb 4, 2024

Nytelife26 Feb 18, 2024

Nytelife26 Feb 18, 2024

Nytelife26 commented Feb 18, 2024

Nytelife26 commented May 13, 2024

		@@ -1,5 +1,5 @@

		#line-length = 90
		line-length = 80

		@@ -1,5 +1,5 @@

		#line-length = 90
		line-length = 80

modernization of proselint #1361

modernization of proselint #1361

Conversation

orgua commented Jan 5, 2024 • edited Loading

Nytelife26 commented Jan 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ferdnyc May 8, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

orgua commented Jan 25, 2024 • edited Loading

Nytelife26 commented Jan 25, 2024

orgua commented Jan 25, 2024

Nytelife26 commented Feb 4, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Nytelife26 commented Feb 18, 2024

Nytelife26 commented May 13, 2024

orgua commented Jan 5, 2024 •

edited

Loading

ferdnyc May 8, 2024 •

edited

Loading

orgua commented Jan 25, 2024 •

edited

Loading