Skip to content
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.

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

Introduce PackageName, to fully type a package name #2801

Merged
merged 1 commit into from
Jan 15, 2024

Conversation

Geod24
Copy link
Member

@Geod24 Geod24 commented Jan 15, 2024

Package names being passed around in the Dub codebase are string, which is problematic as it suffers from validation / semantic issues. Validation because we cannot impose restrictions on characters or length easily, and semantic because some functions expect a main package while some would accept a subpackage. Introducing a type will remedy both those issues.

Note that this just replaces use of the two functions that deal with package names as string. Deprecating / replacing the API is another undertaking that I felt was best done separately.

Copy link

github-actions bot commented Jan 15, 2024

✅ PR OK, no changes in deprecations or warnings

Total deprecations: 0

Total warnings: 0

Build statistics:

 statistics (-before, +after)
-executable size=5228376 bin/dub
-rough build time=61s
+executable size=5277720 bin/dub
+rough build time=62s
Full build output
DUB version 1.35.1, built on Jan  6 2024
LDC - the LLVM D compiler (1.36.0):
  based on DMD v2.106.1 and LLVM 17.0.6
  built with LDC - the LLVM D compiler (1.36.0)
  Default target: x86_64-unknown-linux-gnu
  Host CPU: znver3
  http://dlang.org - http://wiki.dlang.org/LDC


  Registered Targets:
    aarch64     - AArch64 (little endian)
    aarch64_32  - AArch64 (little endian ILP32)
    aarch64_be  - AArch64 (big endian)
    amdgcn      - AMD GCN GPUs
    arm         - ARM
    arm64       - ARM64 (little endian)
    arm64_32    - ARM64 (little endian ILP32)
    armeb       - ARM (big endian)
    avr         - Atmel AVR Microcontroller
    bpf         - BPF (host endian)
    bpfeb       - BPF (big endian)
    bpfel       - BPF (little endian)
    hexagon     - Hexagon
    lanai       - Lanai
    loongarch32 - 32-bit LoongArch
    loongarch64 - 64-bit LoongArch
    mips        - MIPS (32-bit big endian)
    mips64      - MIPS (64-bit big endian)
    mips64el    - MIPS (64-bit little endian)
    mipsel      - MIPS (32-bit little endian)
    msp430      - MSP430 [experimental]
    nvptx       - NVIDIA PTX 32-bit
    nvptx64     - NVIDIA PTX 64-bit
    ppc32       - PowerPC 32
    ppc32le     - PowerPC 32 LE
    ppc64       - PowerPC 64
    ppc64le     - PowerPC 64 LE
    r600        - AMD GPUs HD2XXX-HD6XXX
    riscv32     - 32-bit RISC-V
    riscv64     - 64-bit RISC-V
    sparc       - Sparc
    sparcel     - Sparc LE
    sparcv9     - Sparc V9
    spirv32     - SPIR-V 32-bit
    spirv64     - SPIR-V 64-bit
    systemz     - SystemZ
    thumb       - Thumb
    thumbeb     - Thumb (big endian)
    ve          - VE
    wasm32      - WebAssembly 32-bit
    wasm64      - WebAssembly 64-bit
    x86         - 32-bit X86: Pentium-Pro and above
    x86-64      - 64-bit X86: EM64T and AMD64
    xcore       - XCore
   Upgrading project in /home/runner/work/dub/dub/
    Starting Performing "release" build using /opt/hostedtoolcache/dc/ldc2-1.36.0/x64/ldc2-1.36.0-linux-x86_64/bin/ldc2 for x86_64.
    Building dub 1.36.0-beta.1+commit.42.gef6cb741: building configuration [application]
     Linking dub
STAT:statistics (-before, +after)
STAT:executable size=5277720 bin/dub
STAT:rough build time=62s

@Geod24
Copy link
Member Author

Geod24 commented Jan 15, 2024

This is a much simpler approach than #2360 and can be built on.
CC @nordlow

Package names being passed around in the Dub codebase are string,
which is problematic as it suffers from validation / semantic issues.
Validation because we cannot impose restrictions on characters
or length easily, and semantic because some functions expect a main
package while some would accept a subpackage. Introducing a type
will remedy both those issues.
@Geod24 Geod24 force-pushed the mlang/PackageName branch from 1e1bd74 to 8744904 Compare January 15, 2024 15:39
@PetarKirov PetarKirov merged commit f09eca3 into dlang:master Jan 15, 2024
30 checks passed
@PetarKirov
Copy link
Member

@Geod24 does it make sense to rebase #2360 now that this PR is merged? Are there useful stuff that we can salvage?

@Geod24 Geod24 deleted the mlang/PackageName branch January 15, 2024 19:01
@Geod24
Copy link
Member Author

Geod24 commented Jan 15, 2024

Not that I can think of. I started to adapt the APIs locally, mostly for the benefit of the PackageManager. Already found a bug!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants