bug#49346: headings when using sh-mode

bug#49346: headings when using sh-mode

[lisa-asket]

[-- Attachment #1: Type: text/plain, Size: 666 bytes --]


Have been reviewing some functionality in a bash script that I use with my .bashrc.



I enabled `outline-minor-mode` and found that by default `sh-script` uses `*`, `**`, `***`

as headings.  Because the headings are not part of comments, my bash script breaks 

if I use headings in this way.  Headings normally start with the comment character.



Also realised that the same colour is used for all heading levels, making it difficult to

individualise the level structure.  The colours seem to change by mode, whereas it would

be more appreciated if outline-minor-mode utilises tho same set of heading level colouring

in all modes.



[-- Attachment #2: Type: text/html, Size: 755 bytes --]

bug#49346: headings when using sh-mode

[Lars Ingebrigtsen]

lisa-asket@perso.be writes:

> I enabled `outline-minor-mode` and found that by default `sh-script`
> uses `*`, `** `, `***` as headings.  Because the headings are not part
> of comments, my bash script breaks if I use headings in this way.
> Headings normally start with the comment character.

`sh-mode' has no support for outlining, so `outline-minor-mode' just
uses the default values for `outline-regexp'.  So I guess this is a
wishlist item for adding support for outlining in `sh-mode'?

Does anybody have a suggestion for what that should be in `sh-mode', or
whether this doesn't really make sense for `sh-mode'?

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

bug#49346: headings when using sh-mode

[lisa-asket]

[-- Attachment #1: Type: text/plain, Size: 1168 bytes --]

I have been using 



# h1

# h2

# h3



This is similar to defining headers in html without ending up using long repeating symbols 

such as `#####` or `*******`.  The number at the end defines the headline level.



From: Lars Ingebrigtsen <larsi@gnus.org>
To: lisa-asket@perso.be
Subject: bug#49346: headings when using sh-mode
Date: 04/07/2021 15:54:55 Europe/Paris
Cc: 49346@debbugs.gnu.org

lisa-asket@perso.be writes:

> I enabled `outline-minor-mode` and found that by default `sh-script`
> uses `*`, `** `, `***` as headings. Because the headings are not part
> of comments, my bash script breaks if I use headings in this way.
> Headings normally start with the comment character.

`sh-mode' has no support for outlining, so `outline-minor-mode' just
uses the default values for `outline-regexp'. So I guess this is a
wishlist item for adding support for outlining in `sh-mode'?

Does anybody have a suggestion for what that should be in `sh-mode', or
whether this doesn't really make sense for `sh-mode'?

-- 
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no





[-- Attachment #2: Type: text/html, Size: 1550 bytes --]

bug#49346: headings when using sh-mode

[lisa-asket]

[-- Attachment #1: Type: text/plain, Size: 1541 bytes --]

After thinking a bit more about this, it would be better to use two ## at the beginning for headings,

such that single # is for normal headings.


## h1

## h2

## h3





From: lisa-asket@perso.be
To: Lars Ingebrigtsen <larsi@gnus.org>
Subject: bug#49346: headings when using sh-mode
Date: 04/07/2021 19:18:08 Europe/Paris
Cc: 49346@debbugs.gnu.org

I have been using 



# h1

# h2

# h3



This is similar to defining headers in html without ending up using long repeating symbols 

such as `#####` or `*******`.  The number at the end defines the headline level.



From: Lars Ingebrigtsen <larsi@gnus.org>
To: lisa-asket@perso.be
Subject: bug#49346: headings when using sh-mode
Date: 04/07/2021 15:54:55 Europe/Paris
Cc: 49346@debbugs.gnu.org

lisa-asket@perso.be writes:

> I enabled `outline-minor-mode` and found that by default `sh-script`
> uses `*`, `** `, `***` as headings. Because the headings are not part
> of comments, my bash script breaks if I use headings in this way.
> Headings normally start with the comment character.

`sh-mode' has no support for outlining, so `outline-minor-mode' just
uses the default values for `outline-regexp'. So I guess this is a
wishlist item for adding support for outlining in `sh-mode'?

Does anybody have a suggestion for what that should be in `sh-mode', or
whether this doesn't really make sense for `sh-mode'?

-- 
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no





[-- Attachment #2: Type: text/html, Size: 2125 bytes --]

bug#49346: headings when using sh-mode

[Lars Ingebrigtsen]

lisa-asket@perso.be writes:

> After thinking a bit more about this, it would be better to use two ## at the
> beginning for headings,

This has now been added to Emacs 28.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no