topic Re: JSL: if - else -> find the commas? in Discussions

JSL: if - else -> find the commas?

hogi — Wed, 13 Sep 2023 20:08:00 GMT

Hi,

I often face the problem that a code doesn't work because 1 out of 10 semicolons is a comma or one comma which belongs to the if block is actually missing.

Is there an easy trick to make the blocks in an if-else clause more visible?

Re: JSL: if - else -> find the commas?

txnelson — Thu, 24 Nov 2022 20:53:31 GMT

Right click on the JSL window, and select "Reformat Script".

That will align the blocks at standard indentations.

You can also click on any function or matrix boundary bracket {} [] and it will select the matching bracket

Re: JSL: if - else -> find the commas?

Ressel — Fri, 25 Nov 2022 08:36:25 GMT

I liked what this man had to say here.

JMP doesn’t care about this formatting but you will quickly get into a mess if you don’t have the discipline to write the code in a way that reflects the hierarchy of display boxes.

This statement doesn't exclusively apply to display boxes, but JSL in general. I am still learning myself, but it is a good investment of time to visually structure code into logical parts, even if it sometimes turns into a forensic exercise (which, coincindentally, is where most learning tends to happen).

Re: JSL: if - else -> find the commas?

hogi — Wed, 28 Jun 2023 16:50:46 GMT

Hm, I just thought:

If there is this wonderful GraphBuilder in Jmp which helps you to generate every kind of graph within 5 seconds,

it should also be possible to analyze complicated If & Match structures in < 5 seconds to find any error in the structure.

Automatic indentation via "reformat script" is great - it shows the complete hierarchy of the code structure - at a single glance.

But that's also the disadvantage: The complete hierarchy

This is why a human eye needs some time to analyze the information - and even needs some support from the brain to do so.
There are ways to encode information in a format where the "eye" needs less support from the brain - as one can learn from @XanGregg :

Thinking along this line ...

A Click on a bracket to highlight the If statement is very useful

- but it would be great if the shading of the included text was not uniform (like in the picture on the left) - but in a meaningful way (like in the picture on the right).

Jmp has all the information that is needed (it uses it to adjust the indentation) - why not use it for the shading?

It's clear that there is NO additional information in the picture on the right which cannot be deduced from the indentation on the left.

And the indentation can even show more: the complete hierarchy of the complex code structure at a single glance. Yes.

But the right image looks quite convinding, right?

edit: link to the wish

Re: JSL: if - else -> find the commas?

txnelson — Fri, 25 Nov 2022 12:15:06 GMT

I like your thinking on this, and other thoughts you are having on improvements to JMP and JSL.....I suggest you add these to the JMP Wish List,. That will get your input to the individuals who can actually make the changes.

Re: JSL: if - else -> find the commas?

hogi — Wed, 28 Jun 2023 16:51:26 GMT

thank you for your support :)

here is the wish:

Re: JSL: if - else -> find the commas?

pauldeen — Fri, 25 Nov 2022 14:15:49 GMT

JMP should hire you into a product quality role! Love it!

Re: JSL: if - else -> find the commas?

ErraticAttack — Sun, 27 Nov 2022 05:55:09 GMT

My solution to this is to put important commas at the level of the enclosing fence. Here is an example -- notice that the commas separating the IF blocks are at the level of the IF statement, and the same for TRY

Names Default to Here( 1 );
dt = Current Data Table();

Try(
	If( Contains( dt << Get Column Names, As Name( "height" ) ),
		mean = Col Mean( dt:height );
		max = Col Max( dt:height );
		min = Col Min( dt:height );
		std dev = Col Std Dev( dt:height );
		Write( "\!NSome stats on :HEIGHT:",
			"\!NMin: ", min,
			"\!NMax: ", max,
			"\!NMean: ", mean,
			"\!NStd Dev: ", std dev
		)
	,
		Contains( dt << Get Column Names, As Name( "weight" ) ),
		mean = Col Mean( dt:weight );
		max = Col Max( dt:weight );
		min = Col Min( dt:weight );
		std dev = Col Std Dev( dt:weight );
		Write( "\!NSome stats on :WEIGHT:",
			"\!NMin: ", min,
			"\!NMax: ", max,
			"\!NMean: ", mean,
			"\!NStd Dev: ", std dev
		)
	,
		Contains( dt << Get Column Names, As Name( "age" ) ),
		mean = Col Mean( dt:age );
		max = Col Max( dt:age );
		min = Col Min( dt:age );
		std dev = Col Std Dev( dt:age );
		Write( "\!NSome stats on :AGE:",
			"\!NMin: ", min,
			"\!NMax: ", max,
			"\!NMean: ", mean,
			"\!NStd Dev: ", std dev
		)
	,
		Print( "Cannot find columns 'height', 'weight', or 'age'" )
	)
,
	Print( "mistakes were made" )
)

Re: JSL: if - else -> find the commas?

jthi — Sun, 27 Nov 2022 07:56:17 GMT

I use a bit similar style as @ErraticAttack but I separate conditions to same line as , and might even comment else and catch if the blocks are long

Names Default To Here(1);
dt = Current Data Table();

Try(
	If(Is Empty(dt),
		print("no table found");
	, N Rows(dt) == 0,
		print("table has no data");
	, N Rows(dt) <= 10,
		print("not enough data");
	, // else
		print("ok")
	);		
, // catch
	show(exception_msg);
);

I try to avoid using jsl re-formatting after my scripts gets long /complicated enough as I usually have to clean-up after using it. Even if reformat was as flexible as I would need it to be, I think I wouldn't bother configuring it properly...

Re: JSL: if - else -> find the commas?

hogi — Sun, 27 Nov 2022 12:32:44 GMT

@jthi wrote:
configuring [re-formatting] properly...

is there a way to configure re-formatting?

Re: JSL: if - else -> find the commas?

jthi — Sun, 27 Nov 2022 10:52:30 GMT

Not to my knowledge. Currently the few changes you can are found from preferences Script Editor page.

Also writing customizable auto-formatter isn't the most simple task (at least I would think so) and I'm not even sure if it is a good idea. I think opinionated auto-formatters are more common and most likely better than fully customizable ones. But JSL has no style guides to follow, so there is no common opinion to base the auto-formatter on (JSL is very small language).

Here is a video regarding black auto-formatter for Python Łukasz Langa - Life Is Better Painted Black, or: How to Stop Worrying and Embrace Auto-Formatting (youtube.com)

Re: JSL: if - else -> find the commas?

David_Burnham — Mon, 28 Nov 2022 08:30:44 GMT

I agree with @jthi , I avoid using re-format. It's my job as a programmer to have a clear style guide and enforce it as I write the code.

Annotations such as

, // else

can help give a visual guide when there are a large number of lines of code.

I too, think aligning the comma with the main if statement is the preferable style.

Re: JSL: if - else -> find the commas?

ron_horne — Wed, 30 Nov 2022 10:20:16 GMT

Hi @hogi ,

This is not an exact answer to your specific question. But i think this jsl extension for visual studio provides a better scripting experience in general.

https://marketplace.visualstudio.com/items?itemName=VinceFaller.jmp-scripting

Re: JSL: if - else -> find the commas?

hogi — Mon, 05 Dec 2022 14:57:41 GMT

Oh no - once again, after some copy & paste and re-arrangement of my code it behaves as if there was a wrong comma somewhere in an if statement

- and I wished there was a highlight function implemented already in Jmp17 :)

Hm, not yet ...

So I went back to the suggestions in the posts and searched for some help.

While reading the suggestions the first time I thought: sounds good, many of them will help me when I have the next problem.

Now, when searching for the erroneously placed comma, actually it was @txnelson's suggestion which helped me to find it:
Click on reformat script and check where the indentation doesn't fit to the expected one.

Quite simple - and as expected.

On the other hand, while searching again and again for the wrong comma, the other suggestions read a bit like

"there is a comma where it should not be? you have to find it and correct it".

To combine both approaches ,to write your code

1) in a readable way
2) such that reformat script doesn't change the formatting.

One could put an empty line in front of the commas in the if statements. This will prevent reformat script from moving the commas to the end of the previous line. Unfortunately, it will also shift the code after the commas to the next line, just leaving the commas there - which makes the code a bit "wide-meshed" and difficult to read. Hm.

Names Default To Here( 1 );
dt = Current Data Table();
If(
	Is Empty( dt ),
		Print( "no table found" );
		
,
	N Rows( dt ) == 0,
		Print( "table has no data" );
		
, // else
	Print( "ok" )
);

Try on your own: Wherer is the erroneously placed comma
code as it was provided by ErraticAttack, but with a comma where there should be a semicolon:

Names Default to Here( 1 );
dt = Current Data Table();

Try(
	If( Contains( dt << Get Column Names, As Name( "height" ) ),
		mean = Col Mean( dt:height );
		max = Col Max( dt:height );
		min = Col Min( dt:height );
		std dev = Col Std Dev( dt:height ),
		Write( "\!NSome stats on :HEIGHT:",
			"\!NMin: ", min,
			"\!NMax: ", max,
			"\!NMean: ", mean,
			"\!NStd Dev: ", std dev
		)
	,
		Contains( dt << Get Column Names, As Name( "weight" ) ),
		mean = Col Mean( dt:weight );
		max = Col Max( dt:weight );
		min = Col Min( dt:weight );
		std dev = Col Std Dev( dt:weight );
		Write( "\!NSome stats on :WEIGHT:",
			"\!NMin: ", min,
			"\!NMax: ", max,
			"\!NMean: ", mean,
			"\!NStd Dev: ", std dev
		)
	,
		Contains( dt << Get Column Names, As Name( "age" ) ),
		mean = Col Mean( dt:age );
		max = Col Max( dt:age );
		min = Col Min( dt:age );
		std dev = Col Std Dev( dt:age );
		Write( "\!NSome stats on :AGE:",
			"\!NMin: ", min,
			"\!NMax: ", max,
			"\!NMean: ", mean,
			"\!NStd Dev: ", std dev
		)
	,
		Print( "Cannot find columns 'height', 'weight', or 'age'" )
	)
,
	Print( "mistakes were made" )
)

after reformat script:
- the wrong comma is easily visible because indentation changed completely.
- (even without a wrong comma) all commas are moved to the end of the previous line - which makes it more difficult to analyze the structure

Names Default To Here( 1 );
dt = Current Data Table();

Try(
	If(
		Contains( dt << Get Column Names, As Name( "height" ) ),
			mean = Col Mean( dt:height );
			max = Col Max( dt:height );
			min = Col Min( dt:height );
			std dev = Col Std Dev( dt:height );, // <- wrong comma
		Write( //<- "wrong" indentation gives the hint
			"\!NSome stats on :HEIGHT:",
			"\!NMin: ",
			min,
			"\!NMax: ",
			max,
			"\!NMean: ",
			mean,
			"\!NStd Dev: ",
			std dev
		), Contains( dt << Get Column Names, As Name( "weight" ) ),
		mean = Col Mean( dt:weight );
		max = Col Max( dt:weight );
		min = Col Min( dt:weight );
		std dev = Col Std Dev( dt:weight );
		Write(
			"\!NSome stats on :WEIGHT:",
			"\!NMin: ",
			min,
			"\!NMax: ",
			max,
			"\!NMean: ",
			mean,
			"\!NStd Dev: ",
			std dev
		);, Contains( dt << Get Column Names, As Name( "age" ) ),
		mean = Col Mean( dt:age );
		max = Col Max( dt:age );
		min = Col Min( dt:age );
		std dev = Col Std Dev( dt:age );
		Write(
			"\!NSome stats on :AGE:",
			"\!NMin: ",
			min,
			"\!NMax: ",
			max,
			"\!NMean: ",
			mean,
			"\!NStd Dev: ",
			std dev
		);, Print( "Cannot find columns 'height', 'weight', or 'age'" )
	)
,
	Print( "mistakes were made" )
);

Re: JSL: if - else -> find the commas?

Jeff_Perkinson — Sun, 04 Dec 2022 20:54:31 GMT

Pasting the If() statement into the Formula editor helps spot it pretty quickly.

Re: JSL: if - else -> find the commas?

hogi — Mon, 05 Dec 2022 14:59:26 GMT

cool, very convenient :)

Re: JSL: if - else -> find the commas?

hogi — Sun, 29 Dec 2024 19:58:38 GMT

a nice example what can go wrong:

x= if(
// 1st test

    1==3,
	1
, // 2nd test
	1==5,
	2,
, // others
	3
)

after executing the code, x= ...

hint:

... no error message?

Re: JSL: if - else -> find the commas?

hogi — Sun, 29 Dec 2024 20:00:53 GMT

Guys, this is almost perfect:

https://community.jmp.com/t5/Discussions/If-statement-comma/m-p/824212/highlight/true#M100363

nice workaround
... till gets available.