refactor: tidy up workspace name validation and fix docs (#522)

Fixes #519

docs/configuration/overview.mdx

@@ -19,7 +19,7 @@ project.
 The name of this project for display purposes within IO environments and IDEs.
 
 ```yaml
-name: My Awesome Project
+name: my_project
 ```
 
 ## repository

docs/getting-started.mdx

@@ -37,7 +37,7 @@ If you don't have a `pubspec.yaml` file at the workspace root yet, create one
 now:
 
 ```yaml
-name: <project>_workspace
+name: my_project_workspace
 
 environment:
   sdk: '>=2.18.0 <3.0.0'
@@ -58,7 +58,7 @@ Next create a `melos.yaml` file at the repository root. Within the `melos.yaml`
 file, add the `name` and `packages` fields:
 
 ```yaml
-name: <project>
+name: my_project
 
 packages:
   - packages/*

docs/guides/migrations.mdx

@@ -24,7 +24,7 @@ If you don't have a `pubspec.yaml` file at the workspace root yet, create one
 now:
 
 ```yaml
-name: <project>_workspace
+name: my_project_workspace
 
 environment:
   sdk: '>=2.18.0 <3.0.0'

packages/melos/lib/src/command_runner/version.dart

@@ -261,9 +261,8 @@ class VersionCommand extends MelosCommand {
       return ManualVersionChange.incrementBuildNumber();
     }
 
-    final semverReleaseType = SemverReleaseType.values.firstWhereOrNull(
-      (releaseType) => describeEnum(releaseType) == argument,
-    );
+    final semverReleaseType = SemverReleaseType.values
+        .firstWhereOrNull((releaseType) => releaseType.name == argument);
     if (semverReleaseType != null) {
       return ManualVersionChange.incrementBySemverReleaseType(
         semverReleaseType,

packages/melos/lib/src/common/utils.dart

@@ -64,8 +64,6 @@ extension Let<T> on T? {
   }
 }
 
-String describeEnum(Object value) => value.toString().split('.').last;
-
 /// Utility function to write inline multi-line strings with indentation and
 /// without trailing a new line.
 ///

packages/melos/lib/src/package.dart

@@ -75,6 +75,13 @@ Uri get pubUrl => Uri.parse(
       currentPlatform.environment['PUB_HOSTED_URL'] ?? 'https://pub.dev',
     );
 
+final _isValidPubPackageNameRegExp =
+    RegExp(r'^[a-z][a-z\d_-]*$', caseSensitive: false);
+
+/// Returns whether the given [name] is a valid pub package name.
+bool isValidPubPackageName(String name) =>
+    _isValidPubPackageNameRegExp.hasMatch(name);
+
 /// Enum representing what type of package this is.
 enum PackageType {
   dartPackage,

packages/melos/lib/src/workspace_configs.dart

@@ -29,6 +29,7 @@ import 'common/glob.dart';
 import 'common/io.dart';
 import 'common/utils.dart';
 import 'common/validation.dart';
+import 'package.dart';
 import 'scripts.dart';
 
 /// IDE-specific configurations.
@@ -855,11 +856,9 @@ class MelosWorkspaceConfig {
     required String path,
   }) {
     final name = assertKeyIsA<String>(key: 'name', map: yaml);
-    final isValidDartPackageNameRegExp =
-        RegExp(r'^[a-z][a-z\d_-]*$', caseSensitive: false);
-    if (!isValidDartPackageNameRegExp.hasMatch(name)) {
+    if (!isValidPubPackageName(name)) {
       throw MelosConfigException(
-        'The name $name is not a valid dart package name',
+        'The name $name is not a valid pub package name.',
       );
     }