From 5adf648265b7275dcedd53b7efcf25a98711177d Mon Sep 17 00:00:00 2001 From: Christoph Thiede Date: Sun, 5 Jan 2025 00:32:48 +0100 Subject: [PATCH] fix typos in some test descriptions --- .../SLSmallLintPlugIn.class/class/smallLintTests.st | 3 ++- .../SLSmallLintPlugIn.class/methodProperties.json | 2 +- .../instance/instanceVariableAccessIsConsistent..st | 2 +- .../SLSwaMetricsPlugIn.class/instance/magicNumbers..st | 2 +- .../SLSwaMetricsPlugIn.class/instance/nilProgramming..st | 2 +- .../SLSwaMetricsPlugIn.class/instance/noClassComments..st | 2 +- .../SLSwaMetricsPlugIn.class/methodProperties.json | 8 ++++---- .../instance/mapCascadeWithoutYourself..st | 2 +- .../instance/mapHardcodedClassReference..st | 2 +- .../SL2DefaultTestMapper.class/methodProperties.json | 4 ++-- 10 files changed, 15 insertions(+), 14 deletions(-) diff --git a/packages/SwaLint-PlugIns.package/SLSmallLintPlugIn.class/class/smallLintTests.st b/packages/SwaLint-PlugIns.package/SLSmallLintPlugIn.class/class/smallLintTests.st index 03fda4ba..9126b841 100644 --- a/packages/SwaLint-PlugIns.package/SLSmallLintPlugIn.class/class/smallLintTests.st +++ b/packages/SwaLint-PlugIns.package/SLSmallLintPlugIn.class/class/smallLintTests.st @@ -19,10 +19,11 @@ smallLintTests {#InstVarInSubclasses. 'Instance var in subclasses'. 'Instance variables defined in all subclasses'. true.}. {#JustSendsSuper. 'Just sends super'. 'Method just sends super message'. true.}. {#LiteralArrayContainsComma. 'Literal array contains a comma'. 'Literal array contains a #,'. true.}. + {#LiteralArrayContainsDot. 'Literal array contains a dot'. 'Literal array contains a #''.'''. true.}. {#LiteralArrayContainsSuspiciousTrueFalseOrNil. 'Literal array contains a #true, #false, or #nil but the source doesn''t.'. 'With ANSI changes, #(true false nil) now is equal to {true. false. nil} not {#true. #false. #nil} as it used to be. This may be a bug.'. true.}. {#LongMethods. 'Long methods'. 'Description'. false.}. - {#MethodHasNoTimeStamp. 'Method has no timeStamp'. 'For proper versioning, every method should have a timestamp.'. true.}. + {#MethodHasNoTimeStamp. 'Method has no timeStamp'. 'For proper change tracking, every method should have a timestamp.'. true.}. {#MethodSourceContainsLinefeeds. 'Method source contains linefeeds'. 'Squeak code should not contain linefeed characters.'. true.}. {#MissingSubclassResponsibility. 'Missing subclass responsibility'. 'Method defined in all subclasses, but not in superclass'. false.}. {#OnlyReadOrWritten. 'OnlyReadOrWritten'. 'Instance variables not read AND written'. true.}. diff --git a/packages/SwaLint-PlugIns.package/SLSmallLintPlugIn.class/methodProperties.json b/packages/SwaLint-PlugIns.package/SLSmallLintPlugIn.class/methodProperties.json index 23beca3d..f7f17e33 100644 --- a/packages/SwaLint-PlugIns.package/SLSmallLintPlugIn.class/methodProperties.json +++ b/packages/SwaLint-PlugIns.package/SLSmallLintPlugIn.class/methodProperties.json @@ -13,7 +13,7 @@ "possibleRuleClasses" : "topa 1/19/2015 14:16", "postfix" : "topa 4/21/2010 08:18", "removePreferences" : "ct 12/13/2024 05:00", - "smallLintTests" : "topa 4/21/2010 08:51", + "smallLintTests" : "ct 12/18/2024 22:51", "subclassesIfAvailable:" : "topa 1/19/2015 14:14", "testSymbolForLintClassName:" : "topa 4/21/2010 08:47" }, "instance" : { diff --git a/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/instance/instanceVariableAccessIsConsistent..st b/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/instance/instanceVariableAccessIsConsistent..st index f49b9664..b936c2b6 100644 --- a/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/instance/instanceVariableAccessIsConsistent..st +++ b/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/instance/instanceVariableAccessIsConsistent..st @@ -2,7 +2,7 @@ tests instanceVariableAccessIsConsistent: aSLClassTestObject + description: 'Checks for consistent access to instance variables. Direct access to instance variables is a bad practice. You should rather use "self " to access it.'> aSLClassTestObject shouldBeClass. ^ self diff --git a/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/instance/magicNumbers..st b/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/instance/magicNumbers..st index 4401a3df..33ab38a2 100644 --- a/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/instance/magicNumbers..st +++ b/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/instance/magicNumbers..st @@ -2,7 +2,7 @@ private magicNumbers: aSLClassTestObject + description: 'A simple magic number test. Magic numbers defined by this test are all numbers, which are not a -1, 0 or 1 and do not appear as the single value in a return statement or in an assignment. Numbers in strings are ignored.'> aSLClassTestObject shouldBeClass. ^ self diff --git a/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/instance/nilProgramming..st b/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/instance/nilProgramming..st index e872b342..21acbb7f 100644 --- a/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/instance/nilProgramming..st +++ b/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/instance/nilProgramming..st @@ -2,7 +2,7 @@ tests nilProgramming: aSLClassTestObject + description: 'Consider using the Nil Object pattern instead. Oftentimes, nil values actually have a meaning and can therefore be replaced with a domain specific object. This makes the code more intuitive and debugging easier.'> aSLClassTestObject shouldBeClass. ^ self diff --git a/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/instance/noClassComments..st b/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/instance/noClassComments..st index e9e9306f..52902a9a 100644 --- a/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/instance/noClassComments..st +++ b/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/instance/noClassComments..st @@ -2,7 +2,7 @@ tests noClassComments: aSLClassTestObject + description: 'All classes should have a comment to explain their purpose, collaborations with other classes, and optionally provide examples of use.'> | class | aSLClassTestObject shouldBeClass. diff --git a/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/methodProperties.json b/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/methodProperties.json index 663161c4..208e2e3e 100644 --- a/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/methodProperties.json +++ b/packages/SwaLint-PlugIns.package/SLSwaMetricsPlugIn.class/methodProperties.json @@ -11,8 +11,8 @@ "evilMethods" : "JTM 5/27/2015 11:05", "globalState:" : "BD 6/15/2018 18:53", "instanceVariableAccess:" : "BD 6/16/2018 20:10", - "instanceVariableAccessIsConsistent:" : "BD 6/16/2018 20:12", - "magicNumbers:" : "BD 6/15/2018 18:09", + "instanceVariableAccessIsConsistent:" : "ct 1/4/2025 21:28", + "magicNumbers:" : "ct 1/4/2025 21:28", "metaProgramming:" : "BD 6/15/2018 18:53", "methodHandlesNil:" : "JTM 5/27/2015 14:01", "methodHasComment:" : "JTM 5/27/2015 14:01", @@ -21,8 +21,8 @@ "methodHasNoSender:" : "NA 7/31/2015 17:02", "methodUsesMetaprogramming:" : "JTM 5/27/2015 14:01", "methodsWithoutSenders:" : "NA 7/31/2015 17:15", - "nilProgramming:" : "BD 6/15/2018 18:54", - "noClassComments:" : "BD 6/15/2018 18:17", + "nilProgramming:" : "ct 1/4/2025 21:28", + "noClassComments:" : "ct 1/4/2025 21:29", "printOn:" : "NH 6/24/2015 14:11", "systemLocCount:" : "BD 6/15/2018 18:54", "systemMethodCount:" : "BD 6/15/2018 18:55" } } diff --git a/packages/SwaLintBrowser.package/SL2DefaultTestMapper.class/instance/mapCascadeWithoutYourself..st b/packages/SwaLintBrowser.package/SL2DefaultTestMapper.class/instance/mapCascadeWithoutYourself..st index ee7338cd..6ed0b2ab 100644 --- a/packages/SwaLintBrowser.package/SL2DefaultTestMapper.class/instance/mapCascadeWithoutYourself..st +++ b/packages/SwaLintBrowser.package/SL2DefaultTestMapper.class/instance/mapCascadeWithoutYourself..st @@ -6,5 +6,5 @@ mapCascadeWithoutYourself: aSLTestData ^ (self makeTestFrom: aSLTestData) title: 'Cascade without #yourself'; addCategoryPath: #('possible bugs' 'syntax'); - description: aSLTestData description , '\\Note that this can also be a valid pattern such as "uniqueCoutn := Set new addAll: ''hello world''; size".' withCRs; + description: aSLTestData description , '\\Note that this can also be a valid pattern such as "uniqueCount := Set new addAll: ''hello world''; size".' withCRs; yourself \ No newline at end of file diff --git a/packages/SwaLintBrowser.package/SL2DefaultTestMapper.class/instance/mapHardcodedClassReference..st b/packages/SwaLintBrowser.package/SL2DefaultTestMapper.class/instance/mapHardcodedClassReference..st index d3691bd6..e3cbc63b 100644 --- a/packages/SwaLintBrowser.package/SL2DefaultTestMapper.class/instance/mapHardcodedClassReference..st +++ b/packages/SwaLintBrowser.package/SL2DefaultTestMapper.class/instance/mapHardcodedClassReference..st @@ -3,6 +3,6 @@ mapHardcodedClassReference: aSLTestData ^ (self makeTestFrom: aSLTestData) - title: 'Hardcdoed class reference'; + title: 'Hardcoded class reference'; addCategoryPath: #('code quality' 'syntax'); yourself \ No newline at end of file diff --git a/packages/SwaLintBrowser.package/SL2DefaultTestMapper.class/methodProperties.json b/packages/SwaLintBrowser.package/SL2DefaultTestMapper.class/methodProperties.json index 1fc274c2..29bd041c 100644 --- a/packages/SwaLintBrowser.package/SL2DefaultTestMapper.class/methodProperties.json +++ b/packages/SwaLintBrowser.package/SL2DefaultTestMapper.class/methodProperties.json @@ -19,7 +19,7 @@ "mapBooleanPrecedence:" : "ct 12/19/2024 05:47", "mapBrainClass:" : "ct 12/19/2024 05:19", "mapBrainMethod:" : "ct 12/19/2024 05:19", - "mapCascadeWithoutYourself:" : "ct 12/19/2024 02:44", + "mapCascadeWithoutYourself:" : "ct 1/4/2025 22:21", "mapClassCount:" : "ct 12/19/2024 05:38", "mapClassInstVarNotInitialized:" : "ct 12/19/2024 05:57", "mapClassNameInSelector:" : "ct 12/19/2024 04:12", @@ -55,7 +55,7 @@ "mapGlobalState:" : "ct 12/19/2024 05:39", "mapGodClass:" : "ct 12/19/2024 05:21", "mapGuardingClause:" : "ct 12/19/2024 04:14", - "mapHardcodedClassReference:" : "ct 12/19/2024 04:03", + "mapHardcodedClassReference:" : "ct 1/3/2025 05:43", "mapIfTrueBlocks:" : "ct 12/19/2024 02:32", "mapIfTrueReturns:" : "ct 12/19/2024 05:48", "mapImplementedNotSent:" : "ct 12/18/2024 23:56",