Add new checker : MicFigureCaption by AntoineUsal · Pull Request #1070 · pillar-markup/Microdown

AntoineUsal · 2026-05-04T13:08:21Z

Ducasse · 2026-05-04T13:19:49Z

Tx! I will have a look

Ducasse · 2026-05-04T13:25:55Z

Ok c'est un bon debut. Des captions il peut y en avoir dans les codeBlock et les equations donc est ce que tu peux regarder la logique dans LastPeriodInCaption

Ducasse · 2026-05-05T17:54:38Z

Hi

I realized that I did not implement the choice of checking in LastPeriodInCaption. I got confused by the logic of
MicAnchoredSectionTableFigureChecker where the checks could be extended.

Ducasse · 2026-05-05T17:57:47Z

+{ #category : 'visiting - inline elements' }
+MicFigureCaptionChecker >> visitCode: aCode [
+	| captionText |
+	captionText := ' ' join: (aCode captionElements collect: [ :each | each text ]).


I saw that there is a method caption in the superclass.
Can you check if it is what you need?

Ducasse · 2026-05-05T17:59:04Z

+	| captionText |
+	captionText := ' ' join: (aCode captionElements collect: [ :each | each text ]).
+	(captionText isEmpty or: [ (captionText anySatisfy: #isAlphaNumeric) not ]) ifTrue: [ 
+		self results add: (MicMissingFigureCaptionResult new


Since we should check the caption for code, figure, equation can you create an helper method to define the logic of the test hasCorrectCaption: in a single place?

Ducasse · 2026-05-05T17:59:18Z

+{ #category : 'visiting - inline elements' }
+MicFigureCaptionChecker >> visitMath: aMath [
+	| captionText |
+	captionText := ' ' join: (aMath captionElements collect: [ :each | each text ]).


same remark here.

Ducasse · 2026-05-05T18:00:32Z

+	| captionText |
+
+	self checkCode ifTrue: [ 
+		captionText := ' ' join: (aCode captionElements collect: [ :each | each text ]).


same as previous remark

Ducasse · 2026-05-05T18:01:11Z

-
+
+	self checkFigure ifTrue: [ 
+		captionText := String streamContents: [ :stream | 


If there is no method caption in the class MicFigure then we should define one there and add tests for it.

Ducasse · 2026-05-05T18:01:25Z

-
+
+	self checkMath ifTrue: [ 
+		captionText := ' ' join: (aMath captionElements collect: [ :each | each text ]).


Same remark here.

Ducasse · 2026-05-05T18:02:12Z

+MicFigureCaptionCheckerTest >> testCodeBlockCaptionIsOnlySpaces [
+	| visitor mdFile mem |
+	mem := FileSystem memory root.
+	mdFile := mem / 'test.md'.


can you rename the test.md to convey if the file contains a correct or bogus caption?

Ducasse · 2026-05-05T18:02:27Z

+MicFigureCaptionCheckerTest >> testMathBlockCaptionIsEmpty [
+	| visitor mdFile mem |
+	mem := FileSystem memory root.
+	mdFile := mem / 'test.md'.


same remark

Ducasse · 2026-05-05T18:02:33Z

+MicFigureCaptionCheckerTest >> testMathBlockCaptionIsEmpty [
+	| visitor mdFile mem |
+	mem := FileSystem memory root.
+	mdFile := mem / 'test.md'.


same remark

Ducasse · 2026-05-05T18:03:10Z

We should add support for configureFrom: and explanationForConfiguration

Ducasse · 2026-05-07T12:20:14Z

"checkerConfigurations" : 
			[
			"EmptyCaption" : {
                              checkOnly: [ 'code' , 'figure' ]
                        }
			]
}

By default,

the checker checks everything : checkCode := true.
when there is a configuration: we put the check flags to false and we set to true to the ones specified.

In the example above the author only wants to validate code and figure captions (should not be empty)

Add new checker : MicFigureCaption

e69277b

AntoineUsal requested a review from Ducasse May 4, 2026 13:08

AntoineUsal added 2 commits May 4, 2026 16:18

Missing some tests

3456057

upgrade checker MicFigure

c839fab

Ducasse reviewed May 5, 2026

View reviewed changes

AntoineUsal added 4 commits May 6, 2026 10:39

Some changes for MicFigureCaption

fc7934c

Fix git error

e39a590

add 2 tests

020acab

remove

377e347

AntoineUsal added 3 commits May 7, 2026 15:05

Merge 50bc914

3ff3c96

Change duplicate methods

4c16e88

update config

a46af2e



		self checkFigure ifTrue: [
		captionText := String streamContents: [ :stream \|



		self checkMath ifTrue: [
		captionText := ' ' join: (aMath captionElements collect: [ :each \| each text ]).

Conversation

AntoineUsal commented May 4, 2026

Uh oh!

Ducasse commented May 4, 2026

Uh oh!

Ducasse commented May 4, 2026

Uh oh!

Ducasse commented May 5, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Ducasse commented May 5, 2026

Uh oh!

Ducasse commented May 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants