cci: make section archive signing configurable

Author: ChlodAlejandro

i18n/core/en.json

@@ -24,7 +24,7 @@
 
     "deputy.session.section.close": "Archive section",
     "deputy.session.section.closeComments": "Archiving comments",
-    "deputy.session.section.closeHelp": "Your signature will automatically be included.",
+    "deputy.session.section.closeCommentsSign": "Include my signature",
     "deputy.session.section.closeError": "Some revisions remain unassessed. You must mark these revisions as assessed before archiving this section.",
     "deputy.session.section.closeWarn": "You have unsaved changes. Close the section without saving?",
 

i18n/settings/en.json

@@ -70,6 +70,8 @@
     "deputy.setting.user.cci.signingBehavior.alwaysTraceLastOnly": "Always leave a trace, but sign the last row modified",
     "deputy.setting.user.cci.signingBehavior.lastOnly": "Only sign the last row modified (prevents assessor recognition)",
     "deputy.setting.user.cci.signingBehavior.never": "Never sign rows (prevents assessor recognition)",
+    "deputy.setting.user.cci.signSectionArchive.name": "Sign by default when archiving CCI sections",
+    "deputy.setting.user.cci.signSectionArchive.description": "If enabled, Deputy will enable the \"include my signature\" checkbox by default when archiving a CCI section.",
     "deputy.setting.user.cci.openOldOnContinue.name": "Open old versions on continue",
     "deputy.setting.user.cci.openOldOnContinue.description": "If enabled, all previously-open sections of a given case page will also be opened alongside the section where the \"continue CCI session\" link was clicked.",
 

src/config/UserConfiguration.ts

@@ -141,6 +141,12 @@ export default class UserConfiguration extends ConfigurationBase {
 				ContributionSurveyRowSigningBehavior.Always
 			)
 		),
+		signSectionArchive: new Setting<boolean, boolean>( {
+			defaultValue: true,
+			displayOptions: {
+				type: 'checkbox'
+			}
+		} ),
 		openOldOnContinue: new Setting<boolean, boolean>( {
 			defaultValue: false,
 			displayOptions: {

src/css/deputy.css

@@ -154,6 +154,10 @@ p.dp-messageWidget-message {
 	padding: 8px;
 }
 
+.dp-cs-section-closing {
+	margin: 1em 1.75em;
+}
+
 .dp-cs-section-progress {
 	margin-top: 8px;
 	max-height: 0;

src/ui/root/DeputyContributionSurveySection.tsx

@@ -48,6 +48,7 @@ export default class DeputyContributionSurveySection implements DeputyUIElement
 	rowElements: ( HTMLElement | DeputyContributionSurveyRow )[];
 	closingCheckbox: OO.ui.CheckboxInputWidget;
 	closingComments: OO.ui.TextInputWidget;
+	closingCommentsSign: OO.ui.CheckboxInputWidget;
 	closeButton: OO.ui.ButtonWidget;
 	reviewButton: OO.ui.ButtonWidget;
 	saveButton: OO.ui.ButtonWidget;
@@ -160,15 +161,24 @@ export default class DeputyContributionSurveySection implements DeputyUIElement
 		}
 
 		if ( this.closed ) {
-			final.splice( 1, 0, msgEval(
-				window.deputy.wikiConfig.cci.collapseTop.get(),
-				( ( this.comments ?? '' ) + ' ~~~~' ).trim()
-			).plain() );
+			if ( this._section.originallyClosed ) {
+				// TODO: Fix when not broken
+			} else {
+				let closingComments = ( this.comments ?? '' ).trim();
+				if ( this.closingCommentsSign.isSelected() ) {
+					closingComments += ' ~~~~';
+				}
+
+				final.splice( 1, 0, msgEval(
+					window.deputy.wikiConfig.cci.collapseTop.get(),
+					closingComments
+				).plain() );
 
-			if ( final[ final.length - 1 ].trim().length === 0 ) {
-				final.pop();
+				if ( final[ final.length - 1 ].trim().length === 0 ) {
+					final.pop();
+				}
+				final.push( window.deputy.wikiConfig.cci.collapseBottom.get() );
 			}
-			final.push( window.deputy.wikiConfig.cci.collapseBottom.get() );
 		}
 
 		return final.join( '\n' );
@@ -456,14 +466,17 @@ export default class DeputyContributionSurveySection implements DeputyUIElement
 	}
 
 	/**
-	 * Toggles the closing comments input box. This will disable the input box AND
-	 * hide the element from view.
+	 * Toggles the closing comments input box and signature checkbox.
+	 * This will disable the input box AND hide the element from view.
 	 *
 	 * @param show
 	 */
-	toggleClosingComments( show: boolean ) {
+	toggleClosingElements( show: boolean ) {
 		this.closingComments.setDisabled( !show );
 		this.closingComments.toggle( show );
+
+		this.closingCommentsSign.setDisabled( !show );
+		this.closingCommentsSign.toggle( show );
 	}
 
 	/**
@@ -477,6 +490,7 @@ export default class DeputyContributionSurveySection implements DeputyUIElement
 		this.saveButton?.setDisabled( disabled );
 		this.closingCheckbox?.setDisabled( disabled );
 		this.closingComments?.setDisabled( disabled );
+		this.closingCommentsSign?.setDisabled( disabled );
 		this.rows?.forEach( ( row ) => row.setDisabled( disabled ) );
 
 		this.disabled = disabled;
@@ -557,6 +571,10 @@ export default class DeputyContributionSurveySection implements DeputyUIElement
 			placeholder: mw.msg( 'deputy.session.section.closeComments' ),
 			disabled: true
 		} );
+		this.closingCommentsSign = new OO.ui.CheckboxInputWidget( {
+			selected: window.deputy.config.cci.signSectionArchive.get(),
+			disabled: true
+		} );
 		this.closeButton = new OO.ui.ButtonWidget( {
 			label: mw.msg( 'deputy.session.section.stop' )
 		} );
@@ -674,6 +692,8 @@ export default class DeputyContributionSurveySection implements DeputyUIElement
 			this.setDisabled( false );
 		} );
 
+		// Section closing (archive/ctop) elements
+
 		const closingWarning = DeputyMessageWidget( {
 			classes: [ 'dp-cs-section-unfinishedWarning' ],
 			type: 'error',
@@ -688,23 +708,30 @@ export default class DeputyContributionSurveySection implements DeputyUIElement
 
 		const closingCommentsField = new OO.ui.FieldLayout( this.closingComments, {
 			align: 'top',
-			label: 'Closing comments',
+			label: mw.msg( 'deputy.session.section.closeComments' ),
 			invisibleLabel: true,
-			help: mw.msg( 'deputy.session.section.closeHelp' ),
 			helpInline: true,
 			classes: [ 'dp-cs-section-closingCommentsField' ]
 		} );
-		// Hide by default.
-		closingCommentsField.toggle( false );
-		closingCommentsField.on( 'change', ( v: string ) => {
-			this.comments = v;
+
+		const closingCommentsSignField = new OO.ui.FieldLayout( this.closingCommentsSign, {
+			align: 'inline',
+			label: mw.msg( 'deputy.session.section.closeCommentsSign' )
 		} );
 
-		this.toggleClosingComments( false );
+		const closingFields = <div
+			class="dp-cs-section-closing"
+			style={{ display: 'none' }}
+		>
+			{ unwrapWidget( closingCommentsField ) }
+			{ unwrapWidget( closingCommentsSignField ) }
+		</div>;
+
+		this.toggleClosingElements( false );
 		this.closingCheckbox.on( 'change', ( v: boolean ) => {
 			this.closed = v;
-			closingCommentsField.toggle( v );
-			this.toggleClosingComments( v );
+			closingFields.style.display = v ? '' : 'none';
+			this.toggleClosingElements( v );
 
 			if ( v ) {
 				updateClosingWarning();
@@ -734,15 +761,14 @@ export default class DeputyContributionSurveySection implements DeputyUIElement
 					<div style={{
 						flex: '1',
 						display: 'flex',
-						flexDirection: 'column',
-						justifyContent: 'center'
+						flexDirection: 'column'
 					}}>
 						{ unwrapWidget( new OO.ui.FieldLayout( this.closingCheckbox, {
 							align: 'inline',
 							label: mw.msg( 'deputy.session.section.close' )
 						} ) ) }
 						{ unwrapWidget( closingWarning ) }
-						{ unwrapWidget( closingCommentsField ) }
+						{ closingFields }
 					</div>
 					<div style={{ display: 'flex', alignItems: 'end' }}>
 						{ unwrapWidget( this.closeButton ) }