Skip to content

Add documentation for GHC-21926 #514

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Feb 22, 2025
Merged

Add documentation for GHC-21926 #514

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c26d0f2
Document GHC-21926
FPtje Jun 8, 2024
cc1d70d
Apply suggested title change
FPtje Feb 9, 2025
d5901c6
Explain alphanumeric characters
FPtje Feb 9, 2025
95967c6
Reword the explanation of GHC-21926
FPtje Feb 9, 2025
d406932
Add full stops and extension to GHC-21926
FPtje Feb 9, 2025
f1fde5c
Add suggested nuance
FPtje Feb 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions message-index/messages/GHC-21926/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Version number or non-alphanumeric character in package name
summary: Package imports may only consist of alphanumeric characters, and must omit the version.
severity: error
introduced: 9.6.1
extension: PackageImports
---

Version number or non-alphanumeric character in the package. Alphanumeric characters are letters and numbers, as defined by `Data.Char.isAlphaNum`.
Copy link
Collaborator

@Bodigrim Bodigrim Feb 9, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a bit incomplete: a package name can include dashes, even while Data.Char.isAlphaNum '-' = False.

The actual function GHC uses to validate package names is

looksLikePackageName = all (all isAlphaNum <&&> not . (all isDigit)) . split '-'

So probably something like "Each of dash-separated components of package name must consist of alphanumeric characters (as defined by Data.Char.isAlphaNum), at least one of which is not a digit". What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the late reply. Sounds good! Changed the code 👍

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you push anything? I don't see any changes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yikes, rookie mistake. Pushed as f1fde5c (#514).

Apologies for the inconvenience.

Note that you will also see this error if the package name consists only of digits.
The package name in this case refers to the one mentioned in an import when using the `PackageImports` language extension.
5 changes: 5 additions & 0 deletions ...index/messages/GHC-21926/non-alphanumeric-in-package/after/Non-alphanumeric-in-package.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{-# LANGUAGE PackageImports #-}

module NonAlphanumericCharacterNameInPackage where

import "some-existing-package" Package.With.Non.Alphanumeric.Characters
5 changes: 5 additions & 0 deletions ...ndex/messages/GHC-21926/non-alphanumeric-in-package/before/Non-alphanumeric-in-package.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{-# LANGUAGE PackageImports #-}

module NonAlphanumericCharacterNameInPackage where

import "&*$^%!@()" Package.With.Non.Alphanumeric.Characters
3 changes: 3 additions & 0 deletions message-index/messages/GHC-21926/non-alphanumeric-in-package/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Non-alphanumeric characters in the package name
---
5 changes: 5 additions & 0 deletions message-index/messages/GHC-21926/version-number-in-package/after/Version-name-in-package.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{-# LANGUAGE PackageImports #-}

module VersionNameInPackage where

import "some-package" Package.With.Version
5 changes: 5 additions & 0 deletions message-index/messages/GHC-21926/version-number-in-package/before/Version-name-in-package.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{-# LANGUAGE PackageImports #-}

module VersionNameInPackage where

import "some-package-0.1.2.3" Package.With.Version
3 changes: 3 additions & 0 deletions message-index/messages/GHC-21926/version-number-in-package/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Version number in package name
---