From f2d29900c722957ee971a6812981f79c9c544b6d Mon Sep 17 00:00:00 2001 From: Eric Seidel Date: Tue, 6 Aug 2024 09:27:04 -0700 Subject: [PATCH] chore(mason_logger): v0.2.16 (#1377): Add cspell Add cspell dictionary and make it pass. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Originally I was just trying to fix spelling of "delimeter", but added cspell as practice for myself and figured it might be useful to you. - [ ] โœจ New feature (non-breaking change which adds functionality) - [ ] ๐Ÿ› ๏ธ Bug fix (non-breaking change which fixes an issue) - [ ] โŒ Breaking change (fix or feature that would cause existing functionality to change) - [X] ๐Ÿงน Code refactor - [ ] โœ… Build configuration change - [ ] ๐Ÿ“ Documentation - [ ] ๐Ÿ—‘๏ธ Chore --- cspell.config.yaml | 42 +++++++++++++++++++ extensions/vscode/src/commands/make-brick.ts | 6 +-- packages/mason/CHANGELOG.md | 4 +- packages/mason/lib/src/generator.dart | 4 +- packages/mason/lib/src/path.dart | 2 +- packages/mason/lib/src/yaml_encode.dart | 2 +- .../mason/test/bundles/greeting_bundle.dart | 1 + packages/mason/test/bundles/hooks_bundle.dart | 1 + packages/mason_api/README.md | 2 +- packages/mason_api/example/main.dart | 2 +- .../mason_api/test/src/jwt_decode_test.dart | 2 +- .../mason_api/test/src/mason_api_test.dart | 8 ++-- .../test/bundles/greeting_bundle.dart | 1 + .../mason_cli/test/bundles/hooks_bundle.dart | 1 + .../test/bundles/legacy_greeting_bundle.dart | 1 + .../mason_cli/test/commands/bundle_test.dart | 1 + .../mason_cli/test/commands/login_test.dart | 4 +- .../lib/src/ffi/unix_terminal.dart | 4 ++ packages/mason_logger/lib/src/io.dart | 4 +- .../mason_logger/lib/src/mason_logger.dart | 12 +++--- .../test/src/mason_logger_test.dart | 4 +- 21 files changed, 80 insertions(+), 28 deletions(-) create mode 100644 cspell.config.yaml diff --git a/cspell.config.yaml b/cspell.config.yaml new file mode 100644 index 000000000..045933f36 --- /dev/null +++ b/cspell.config.yaml @@ -0,0 +1,42 @@ +$schema: https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json +version: "0.2" +words: + - APPDATA + - LOCALAPPDATA + - mocktail + - buildroot + - endtemplate + - writeln + - recase + - ints + - combinators + - tearoffs + - pubspec + - unawaited + - interps + - livestream + - angelov + - podfile + - PANA + - recompile + - dartaotruntime + - unbundle + - xlink + - struct + - brickhub + - felangel + - Verdana + - vscodeignore + - nosources + - recompiles + - unbundling + - sublist + - Flutterly + - antiprioritize # This might be an api mistake? + - Yyna + - dylib + - libc + - calloc + - nullptr + - xmit + - keypress \ No newline at end of file diff --git a/extensions/vscode/src/commands/make-brick.ts b/extensions/vscode/src/commands/make-brick.ts index 653e68560..fe4fe544a 100644 --- a/extensions/vscode/src/commands/make-brick.ts +++ b/extensions/vscode/src/commands/make-brick.ts @@ -240,12 +240,12 @@ const promptForList = async ( title: string, separator?: string, ): Promise => { - const delimeter = separator ?? ","; + const delimiter = separator ?? ","; const input = await vscode.window.showInputBox({ prompt: title, - placeHolder: `Enter a list separated by "${delimeter}"`, + placeHolder: `Enter a list separated by "${delimiter}"`, }); - const results = input?.split(delimeter); + const results = input?.split(delimiter); const selection = results?.map((r) => r.trimStart()); return JSON.stringify(JSON.stringify(selection)); }; diff --git a/packages/mason/CHANGELOG.md b/packages/mason/CHANGELOG.md index b965b8006..c8847a29f 100644 --- a/packages/mason/CHANGELOG.md +++ b/packages/mason/CHANGELOG.md @@ -239,7 +239,7 @@ # 0.1.0-dev.16 -- fix: lamdba shorthand syntax interop +- fix: lambda shorthand syntax interop # 0.1.0-dev.15 @@ -699,7 +699,7 @@ vars: - feat: add `lowerCase` and `upperCase` lambdas - fix: support non utf8 encoded files - fix: switch templating engine to be lenient by default -- refactor: avoid templating content with no delimeters +- refactor: avoid templating content with no delimiters # 0.0.1-dev.17 diff --git a/packages/mason/lib/src/generator.dart b/packages/mason/lib/src/generator.dart index b537856ae..a2d1b1f1e 100644 --- a/packages/mason/lib/src/generator.dart +++ b/packages/mason/lib/src/generator.dart @@ -23,7 +23,7 @@ bool get _isAotCompiled => bool.fromEnvironment('dart.vm.product'); final _descriptorPool = Pool(32); final _partialRegExp = RegExp(r'\{\{~\s(.+)\s\}\}'); final _fileRegExp = RegExp(r'{{%\s?([a-zA-Z]+)\s?%}}'); -final _delimeterRegExp = RegExp('{{([^;,=]*?)}}'); +final _delimiterRegExp = RegExp('{{([^;,=]*?)}}'); final _loopKeyRegExp = RegExp('{{#(.*?)}}'); final _loopValueReplaceRegExp = RegExp('({{{.*?}}})'); final _lambdas = RegExp( @@ -512,7 +512,7 @@ class TemplateFile { ) { try { final decoded = utf8.decode(content); - if (!decoded.contains(_delimeterRegExp)) return content; + if (!decoded.contains(_delimiterRegExp)) return content; final rendered = decoded.render(vars, partials); return utf8.encode(rendered); } on Exception { diff --git a/packages/mason/lib/src/path.dart b/packages/mason/lib/src/path.dart index 7b616b1e7..a0ac077be 100644 --- a/packages/mason/lib/src/path.dart +++ b/packages/mason/lib/src/path.dart @@ -2,7 +2,7 @@ import 'package:path/path.dart' as p; /// Canonicalizes [path]. /// -/// This function implements the behaviour of `canonicalize` from +/// This function implements the behavior of `canonicalize` from /// `package:path`. /// However, it does not change the ASCII case of the path. /// See https://github.com/dart-lang/path/issues/102. diff --git a/packages/mason/lib/src/yaml_encode.dart b/packages/mason/lib/src/yaml_encode.dart index 996668bd9..06a851ed9 100644 --- a/packages/mason/lib/src/yaml_encode.dart +++ b/packages/mason/lib/src/yaml_encode.dart @@ -1,4 +1,4 @@ -/// Yaml Utiilities +/// Yaml Utilities class Yaml { /// Encodes a [Map] as `yaml` similar to `json.encode`. static String encode(Map json, [int nestingLevel = 0]) { diff --git a/packages/mason/test/bundles/greeting_bundle.dart b/packages/mason/test/bundles/greeting_bundle.dart index a46bbf286..1ecb612e5 100644 --- a/packages/mason/test/bundles/greeting_bundle.dart +++ b/packages/mason/test/bundles/greeting_bundle.dart @@ -5,6 +5,7 @@ import 'package:mason/mason.dart'; final greetingBundle = MasonBundle.fromJson({ "files": [ + // cspell:disable-next-line {"path": "GREETINGS.md", "data": "SGkge3tuYW1lfX0h", "type": "text"} ], "hooks": [], diff --git a/packages/mason/test/bundles/hooks_bundle.dart b/packages/mason/test/bundles/hooks_bundle.dart index 76221b548..2e61dff41 100644 --- a/packages/mason/test/bundles/hooks_bundle.dart +++ b/packages/mason/test/bundles/hooks_bundle.dart @@ -5,6 +5,7 @@ import 'package:mason/mason.dart'; final hooksBundle = MasonBundle.fromJson({ "files": [ + // cspell:disable-next-line {"path": "hooks.md", "data": "SGkge3tuYW1lfX0h", "type": "text"} ], "hooks": [ diff --git a/packages/mason_api/README.md b/packages/mason_api/README.md index 73c165b52..8a2d9b6f1 100644 --- a/packages/mason_api/README.md +++ b/packages/mason_api/README.md @@ -11,7 +11,7 @@ A Dart API client used by [package:mason_cli](https://github.com/felangel/mason) import 'package:mason_api/mason_api.dart'; const email = 'my@email.com'; -const password = 't0pS3cret!'; +const password = 'top-secret!'; Future main() async { final masonApi = MasonApi(); diff --git a/packages/mason_api/example/main.dart b/packages/mason_api/example/main.dart index ab437386c..7b644ab7f 100644 --- a/packages/mason_api/example/main.dart +++ b/packages/mason_api/example/main.dart @@ -1,7 +1,7 @@ import 'package:mason_api/mason_api.dart'; const email = 'my@email.com'; -const password = 't0pS3cret!'; +const password = 't0pS3cret!'; // cspell:disable-line Future main() async { final masonApi = MasonApi(); diff --git a/packages/mason_api/test/src/jwt_decode_test.dart b/packages/mason_api/test/src/jwt_decode_test.dart index ca54cc5f2..72a4988d8 100644 --- a/packages/mason_api/test/src/jwt_decode_test.dart +++ b/packages/mason_api/test/src/jwt_decode_test.dart @@ -2,7 +2,7 @@ import 'package:mason_api/src/jwt_decode.dart'; import 'package:test/test.dart'; void main() { - const token = + const token = // cspell:disable-next-line '''eyJhbGciOiJSUzI1NiIsImN0eSI6IkpXVCJ9.eyJlbWFpbCI6InRlc3RAZW1haWwuY29tIn0.pD47BhF3MBLyIpfsgWCzP9twzC1HJxGukpcR36DqT6yfiOMHTLcjDbCjRLAnklWEHiT0BQTKTfhs8IousU90Fm5bVKObudfKu8pP5iZZ6Ls4ohDjTrXky9j3eZpZjwv8CnttBVgRfMJG-7YASTFRYFcOLUpnb4Zm5R6QdoCDUYg'''; group('Jwt', () { group('decodeClaims', () { diff --git a/packages/mason_api/test/src/mason_api_test.dart b/packages/mason_api/test/src/mason_api_test.dart index 1ac0f3f9d..ae40cf5c2 100644 --- a/packages/mason_api/test/src/mason_api_test.dart +++ b/packages/mason_api/test/src/mason_api_test.dart @@ -11,12 +11,12 @@ import 'package:test/test.dart'; class _MockHttpClient extends Mock implements http.Client {} -const token = +const token = // cspell:disable-next-line '''eyJhbGciOiJSUzI1NiIsImN0eSI6IkpXVCJ9.eyJlbWFpbCI6InRlc3RAZW1haWwuY29tIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlfQ.SaCs1BJ2Oib4TkUeR6p1uh_XnWjJnJpm-dZkL8Whsc_g-NrDKeHhkuVa8fNIbfLtdVeXjVSSi_ZjQDAJho039HSrrdhQAgrRY04cJ6IZCF1HKvJeWDcIihPdl2Zl_V5u9xBxU3ImfGpJ-0O0vCpKHIuDwZsmfN3h_CkDv3SK7lA'''; const authority = 'registry.brickhub.dev'; const credentialsFileName = 'mason-credentials.json'; const email = 'test@email.com'; -const password = 'T0pS3cret!'; +const password = 'T0pS3cret!'; // cspell:disable-line class TestMasonApiException extends MasonApiException { const TestMasonApiException({required super.message, super.details}); @@ -274,7 +274,7 @@ void main() { ).thenAnswer( (_) async => http.Response( json.encode({ - 'access_token': + 'access_token': // cspell:disable-next-line '''eyJhbGciOiJSUzI1NiIsImN0eSI6IkpXVCJ9.eyJmb28iOiJiYXIifQ.LaR0JfOiDrS1AuABC38kzxpSjRLJ_OtfOkZ8hL6I1GPya-cJYwsmqhi5eMBwEbpYHcJhguG5l56XM6dW8xjdK7JbUN6_53gHBosSnL-Ccf29oW71Ado9sxO17YFQyihyMofJ_v78BPVy2H5O10hNjRn_M0JnnAe0Fvd2VrInlIE''', 'refresh_token': '__refresh_token__', 'expires_in': '3600', @@ -526,7 +526,7 @@ void main() { ).thenAnswer( (_) async => http.Response( json.encode({ - 'access_token': + 'access_token': // cspell:disable-next-line '''eyJhbGciOiJSUzI1NiIsImN0eSI6IkpXVCJ9.eyJmb28iOiJiYXIifQ.LaR0JfOiDrS1AuABC38kzxpSjRLJ_OtfOkZ8hL6I1GPya-cJYwsmqhi5eMBwEbpYHcJhguG5l56XM6dW8xjdK7JbUN6_53gHBosSnL-Ccf29oW71Ado9sxO17YFQyihyMofJ_v78BPVy2H5O10hNjRn_M0JnnAe0Fvd2VrInlIE''', 'refresh_token': '__refresh_token__', 'expires_in': '3600', diff --git a/packages/mason_cli/test/bundles/greeting_bundle.dart b/packages/mason_cli/test/bundles/greeting_bundle.dart index 8bfa238b2..d7d007f3b 100644 --- a/packages/mason_cli/test/bundles/greeting_bundle.dart +++ b/packages/mason_cli/test/bundles/greeting_bundle.dart @@ -4,6 +4,7 @@ import 'package:mason/mason.dart'; final greetingBundle = MasonBundle.fromJson({ "files": [ + // cspell:disable-next-line {"path": "GREETINGS.md", "data": "SGkge3tuYW1lfX0h", "type": "text"} ], "hooks": [], diff --git a/packages/mason_cli/test/bundles/hooks_bundle.dart b/packages/mason_cli/test/bundles/hooks_bundle.dart index 76221b548..2e61dff41 100644 --- a/packages/mason_cli/test/bundles/hooks_bundle.dart +++ b/packages/mason_cli/test/bundles/hooks_bundle.dart @@ -5,6 +5,7 @@ import 'package:mason/mason.dart'; final hooksBundle = MasonBundle.fromJson({ "files": [ + // cspell:disable-next-line {"path": "hooks.md", "data": "SGkge3tuYW1lfX0h", "type": "text"} ], "hooks": [ diff --git a/packages/mason_cli/test/bundles/legacy_greeting_bundle.dart b/packages/mason_cli/test/bundles/legacy_greeting_bundle.dart index b43f001fc..67cc94716 100644 --- a/packages/mason_cli/test/bundles/legacy_greeting_bundle.dart +++ b/packages/mason_cli/test/bundles/legacy_greeting_bundle.dart @@ -5,6 +5,7 @@ import 'package:mason/mason.dart'; final legacyGreetingBundle = MasonBundle.fromJson({ "files": [ + // cspell:disable-next-line {"path": "GREETINGS.md", "data": "SGkge3tuYW1lfX0h", "type": "text"} ], "name": "greeting", diff --git a/packages/mason_cli/test/commands/bundle_test.dart b/packages/mason_cli/test/commands/bundle_test.dart index 99596e1e8..b339b3db6 100644 --- a/packages/mason_cli/test/commands/bundle_test.dart +++ b/packages/mason_cli/test/commands/bundle_test.dart @@ -1,3 +1,4 @@ +// cspell:ignore SGkge3tuYW1lfX0h import 'dart:convert'; import 'dart:io'; diff --git a/packages/mason_cli/test/commands/login_test.dart b/packages/mason_cli/test/commands/login_test.dart index df835d5f7..1b02445b7 100644 --- a/packages/mason_cli/test/commands/login_test.dart +++ b/packages/mason_cli/test/commands/login_test.dart @@ -53,7 +53,7 @@ void main() { test('exits with code 70 when MasonApiLoginFailure occurs', () async { const email = 'test@email.com'; - const password = 'T0pS3cret!'; + const password = 'T0pS3cret!'; // cspell:disable-line const message = 'oops something went wrong!'; when( () => logger.prompt('email:', defaultValue: any(named: 'defaultValue')), @@ -86,7 +86,7 @@ void main() { test('exits with code 0 when logged in successfully', () async { const email = 'test@email.com'; - const password = 'T0pS3cret!'; + const password = 'T0pS3cret!'; // cspell:disable-line final user = _MockUser(); when(() => user.email).thenReturn(email); when( diff --git a/packages/mason_logger/lib/src/ffi/unix_terminal.dart b/packages/mason_logger/lib/src/ffi/unix_terminal.dart index 1962793f6..54d7aedc9 100644 --- a/packages/mason_logger/lib/src/ffi/unix_terminal.dart +++ b/packages/mason_logger/lib/src/ffi/unix_terminal.dart @@ -1,6 +1,10 @@ // coverage:ignore-file // ignore_for_file: public_member_api_docs, constant_identifier_names, camel_case_types, non_constant_identifier_names, lines_longer_than_80_chars +// cspell:words tcgetattr BRKINT ICRNL INPCK ISTRIP IXON lflag CSIZE +// cspell:words fildes termios ospeed ispeed tcflag ncss vtime vmin cflag +// cspell:words icanon isig iexten tcsanow tcsetattr FILENO iflag oflag OPOST + import 'dart:ffi'; import 'dart:io'; diff --git a/packages/mason_logger/lib/src/io.dart b/packages/mason_logger/lib/src/io.dart index cad348e49..c4af15bc2 100644 --- a/packages/mason_logger/lib/src/io.dart +++ b/packages/mason_logger/lib/src/io.dart @@ -71,7 +71,7 @@ enum ControlCharacter { /// Neg acknowledge ctrlU, - /// Syncronous idel + /// Synchronous idle ctrlV, /// End of xmit block @@ -83,7 +83,7 @@ enum ControlCharacter { /// End of medium ctrlY, - /// Substitue (suspend) + /// Substitute (suspend) ctrlZ, /// Left arrow diff --git a/packages/mason_logger/lib/src/mason_logger.dart b/packages/mason_logger/lib/src/mason_logger.dart index 8d8b7d0f6..b330fc16c 100644 --- a/packages/mason_logger/lib/src/mason_logger.dart +++ b/packages/mason_logger/lib/src/mason_logger.dart @@ -210,7 +210,7 @@ class Logger { ..echoMode = false ..lineMode = false; - final delimeter = '$separator '; + final delimiter = '$separator '; var rawString = ''; _stdout.write('$message '); @@ -228,7 +228,7 @@ class Logger { if (isDeleteOrBackspaceKey) { if (rawString.isNotEmpty) { - if (rawString.endsWith(delimeter)) { + if (rawString.endsWith(delimiter)) { _stdout.write('\b\b\x1b[K'); rawString = rawString.substring(0, rawString.length - 2); } else { @@ -240,19 +240,19 @@ class Logger { } if (key.char == separator) { - _stdout.write(delimeter); - rawString += delimeter; + _stdout.write(delimiter); + rawString += delimiter; } else { _stdout.write(key.char); rawString += key.char; } } - if (rawString.endsWith(delimeter)) { + if (rawString.endsWith(delimiter)) { rawString = rawString.substring(0, rawString.length - 2); } - final results = rawString.isEmpty ? [] : rawString.split(delimeter); + final results = rawString.isEmpty ? [] : rawString.split(delimiter); const clearLine = '\u001b[2K\r'; _stdout.write( '$clearLine$message ${styleDim.wrap(lightCyan.wrap('$results'))}\n', diff --git a/packages/mason_logger/test/src/mason_logger_test.dart b/packages/mason_logger/test/src/mason_logger_test.dart index c1d901609..d28a98a44 100644 --- a/packages/mason_logger/test/src/mason_logger_test.dart +++ b/packages/mason_logger/test/src/mason_logger_test.dart @@ -1691,7 +1691,7 @@ void main() { ); }); - test('ignores trailing delimter', () { + test('ignores trailing delimiter', () { final keyStrokes = [ KeyStroke.char('d'), KeyStroke.char('a'), @@ -1809,7 +1809,7 @@ void main() { ); }); - test('backspace deletes delimeter', () { + test('backspace deletes delimiter', () { final keyStrokes = [ KeyStroke.char('d'), KeyStroke.char('a'),