processing / processing/processing4

Error Dialog for Invalid Filenames is Incomplete

Ouverte
#754 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Java
Étoiles
494
Forks
183
Merge moyen
4 h 39 min
PR mergées (30 j)
3

Description

In GitLab by @chipbuster on Jul 24, 2023, 18:46

Description

When an invalid sketch name is detected, the resulting error dialog does not include all requirements for filenames. This can result in a filename which appears to follow all the rules being rejected.

Possibly related to #741, but skimming that issue, it looked like that was intended to be about compiler errors, while this is more related to IDE errors.

Expected Behavior

If the filename does not follow all the rules, the error dialog should specify what to change.

Current Behavior

The error dialog says:

<filename> is not a valid name for sketch code.
Better to stick to ASCII, no spaces, and make sure
it doesn't start with a number.

However, this does not address the following cases:

  1. When a non-alphanumeric ASCII character is included in the filename.
  2. When the stem of the filename is longer than 63 characters.

Steps to Reproduce

Create a file named hello-world.pde or a file whose name consists of the letter 'a' 64 times followed by .pde.

Your Environment

  • Processing version: 4.2
  • Operating System and OS version: Arch Linux
  • Other information: I am (mostly) not manually creating filenames which violate these rules. Rather, it's happening because my learning management system (Canvas) likes to rename files on its own whim, and it tends to add these sorts of things.

Possible Causes / Solutions

One solution would be to explicitly name all the requirements for a filename, e.g. the message reads something like

<filename> is not a valid name for a sketch. Your files must:

1. Use only ASCII letters and numbers.
2. Start with a letter.
3. Be shorter than 63 characters.

but this is not complete either (e.g. right now you are allowed to have underscores in the name).

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez dans app/src/processing/app/Sketch.java, autour des vérifications du nom de fichier aux lignes 1870 et 1886, puis suivez l’endroit où le texte de la boîte de dialogue concernant les noms non valides est assemblé. Comparez la boîte de dialogue aux règles de validation, notamment les caractères non alphanumériques, la longueur maximale du radical du nom et les underscores autorisés. Le travail est terminé lorsque la boîte de dialogue explique chaque règle susceptible de rejeter le nom de fichier.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
java
Domaine
desktop
Type d'issue
Bug
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
42/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.