[NonGNU ELPA] New package: hyperdrive-org-transclusion

[NonGNU ELPA] New package: hyperdrive-org-transclusion

[Joseph Turner]

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

Hello all,

<https://git.sr.ht/~ushin/hyperdrive-org-transclusion> extends
org-transclusion by allowing content served over the hyper:// network to
be transcluded using hyperdrive.el.  Installation instructions:

https://ushin.org/hyperdrive/hyperdrive-manual.html#Org_002dtransclusion-integration-1

I look forward to hearing feedback!

Best,

Joseph


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-elpa-packages-hyperdrive-org-transclusion-New-packag.patch --]
[-- Type: text/x-diff, Size: 781 bytes --]

From 754e3358df1c1a03e9f41b5dc2363b1e2d46995e Mon Sep 17 00:00:00 2001
From: Joseph Turner <joseph@breatheoutbreathe.in>
Date: Sat, 14 Sep 2024 16:50:43 -0500
Subject: [PATCH] * elpa-packages (hyperdrive-org-transclusion): New package

---
 elpa-packages | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/elpa-packages b/elpa-packages
index 0ea8b159a6..8bc3e70a68 100644
--- a/elpa-packages
+++ b/elpa-packages
@@ -402,6 +402,10 @@
   :release-branch "stable"
   :doc "doc/hyperdrive.org")
 
+ (hyperdrive-org-transclusion :url "https://git.sr.ht/~ushin/hyperdrive-org-transclusion"
+  :readme "README.org"
+  :news "CHANGELOG.org")
+
  (idle-highlight-mode	:url "https://codeberg.org/ideasman42/emacs-idle-highlight-mode"
   :ignored-files (".elisp-autofmt"))
 
-- 
2.41.0

Re: [NonGNU ELPA] New package: hyperdrive-org-transclusion

[Philip Kaludercic]

Joseph Turner <joseph@ushin.org> writes:

> Hello all,

Hey, sorry for the delay,

> <https://git.sr.ht/~ushin/hyperdrive-org-transclusion> extends
> org-transclusion by allowing content served over the hyper:// network to
> be transcluded using hyperdrive.el.  

Code/content-wise, I cannot really comment on anything as it is based on
multiple layers of API that I am not familiar with.  That being said,
the (display-fill-column-indicator-mode) in the .dir-locals.el file is
very unusual and something I think you should avoid.  Also, an
.elpaignore file that would exclude some of the files that are only
interesting to contributors and maintainers would be nice.

>                                      Installation instructions:
>
> https://ushin.org/hyperdrive/hyperdrive-manual.html#Org_002dtransclusion-integration-1
>
> I look forward to hearing feedback!
>
> Best,
>
> Joseph
>
> From 754e3358df1c1a03e9f41b5dc2363b1e2d46995e Mon Sep 17 00:00:00 2001
> From: Joseph Turner <joseph@breatheoutbreathe.in>
> Date: Sat, 14 Sep 2024 16:50:43 -0500
> Subject: [PATCH] * elpa-packages (hyperdrive-org-transclusion): New package
>
> ---
>  elpa-packages | 4 ++++
>  1 file changed, 4 insertions(+)
>
> diff --git a/elpa-packages b/elpa-packages
> index 0ea8b159a6..8bc3e70a68 100644
> --- a/elpa-packages
> +++ b/elpa-packages
> @@ -402,6 +402,10 @@
>    :release-branch "stable"
>    :doc "doc/hyperdrive.org")
>  
> + (hyperdrive-org-transclusion :url "https://git.sr.ht/~ushin/hyperdrive-org-transclusion"
> +  :readme "README.org"

This file is automatically detected, we just choose to ignore README.md
files by default.

> +  :news "CHANGELOG.org")

Fun fact:  If you call the file NEWS.org, it will be automatically detected.

> +
>   (idle-highlight-mode	:url "https://codeberg.org/ideasman42/emacs-idle-highlight-mode"
>    :ignored-files (".elisp-autofmt"))

-- 
	Philip Kaludercic on siskin

Re: [NonGNU ELPA] New package: hyperdrive-org-transclusion

[Joseph Turner]

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

Philip Kaludercic <philipk@posteo.net> writes:

> Joseph Turner <joseph@ushin.org> writes:
>
>> Hello all,
>
> Hey, sorry for the delay,
>
>> <https://git.sr.ht/~ushin/hyperdrive-org-transclusion> extends
>> org-transclusion by allowing content served over the hyper:// network to
>> be transcluded using hyperdrive.el.  
>
> Code/content-wise, I cannot really comment on anything as it is based on
> multiple layers of API that I am not familiar with.  That being said,
> the (display-fill-column-indicator-mode) in the .dir-locals.el file is
> very unusual and something I think you should avoid.  Also, an
> .elpaignore file that would exclude some of the files that are only
> interesting to contributors and maintainers would be nice.

Thank you for the review!!

The (display-fill-column-indicator-mode) addition was something that we
settled on in the hyperdrive.el project last year as a way to remind
contributors to fill code before committing.  I'm open to removing it.
Would you elaborate on the reasons to avoid it?

>> + (hyperdrive-org-transclusion :url "https://git.sr.ht/~ushin/hyperdrive-org-transclusion"
>> +  :readme "README.org"
>
> This file is automatically detected, we just choose to ignore README.md
> files by default.

Good to know.  I've removed that line in the attached patch.

>> +  :news "CHANGELOG.org")
>
> Fun fact:  If you call the file NEWS.org, it will be automatically detected.

Good to know.  I'd like to leave CHANGELOG.org as it is for now.

Thank you!!

Joseph



[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-elpa-packages-hyperdrive-org-transclusion-New-packag.patch --]
[-- Type: text/x-diff, Size: 755 bytes --]

From 931e466053437a727fea76005b368f436cbf80e9 Mon Sep 17 00:00:00 2001
From: Joseph Turner <joseph@breatheoutbreathe.in>
Date: Sun, 22 Sep 2024 22:46:57 -0700
Subject: [PATCH] * elpa-packages (hyperdrive-org-transclusion): New package

---
 elpa-packages | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/elpa-packages b/elpa-packages
index 0ea8b159a6..3ddbfec540 100644
--- a/elpa-packages
+++ b/elpa-packages
@@ -402,6 +402,9 @@
   :release-branch "stable"
   :doc "doc/hyperdrive.org")
 
+ (hyperdrive-org-transclusion :url "https://git.sr.ht/~ushin/hyperdrive-org-transclusion"
+  :news "CHANGELOG.org")
+
  (idle-highlight-mode	:url "https://codeberg.org/ideasman42/emacs-idle-highlight-mode"
   :ignored-files (".elisp-autofmt"))
 
-- 
2.46.0

Re: [NonGNU ELPA] New package: hyperdrive-org-transclusion

[Philip Kaludercic]

Joseph Turner <joseph@ushin.org> writes:

> Philip Kaludercic <philipk@posteo.net> writes:
>
>> Joseph Turner <joseph@ushin.org> writes:
>>
>>> Hello all,
>>
>> Hey, sorry for the delay,
>>
>>> <https://git.sr.ht/~ushin/hyperdrive-org-transclusion> extends
>>> org-transclusion by allowing content served over the hyper:// network to
>>> be transcluded using hyperdrive.el.  
>>
>> Code/content-wise, I cannot really comment on anything as it is based on
>> multiple layers of API that I am not familiar with.  That being said,
>> the (display-fill-column-indicator-mode) in the .dir-locals.el file is
>> very unusual and something I think you should avoid.  Also, an
>> .elpaignore file that would exclude some of the files that are only
>> interesting to contributors and maintainers would be nice.
>
> Thank you for the review!!
>
> The (display-fill-column-indicator-mode) addition was something that we
> settled on in the hyperdrive.el project last year as a way to remind
> contributors to fill code before committing.  I'm open to removing it.
> Would you elaborate on the reasons to avoid it?

The main reasons is that it involves an `eval' expression, which is
inherently controversial, especially when enabling a visual minor mode.

Have you considered using Git hooks to enforce the style guide?

>>> + (hyperdrive-org-transclusion :url "https://git.sr.ht/~ushin/hyperdrive-org-transclusion"
>>> +  :readme "README.org"
>>
>> This file is automatically detected, we just choose to ignore README.md
>> files by default.
>
> Good to know.  I've removed that line in the attached patch.
>
>>> +  :news "CHANGELOG.org")
>>
>> Fun fact:  If you call the file NEWS.org, it will be automatically detected.
>
> Good to know.  I'd like to leave CHANGELOG.org as it is for now.

This is actually a fairly common file name, that it would be worth
checking for it as well.

> Thank you!!
>
> Joseph
>
>
> From 931e466053437a727fea76005b368f436cbf80e9 Mon Sep 17 00:00:00 2001
> From: Joseph Turner <joseph@breatheoutbreathe.in>
> Date: Sun, 22 Sep 2024 22:46:57 -0700
> Subject: [PATCH] * elpa-packages (hyperdrive-org-transclusion): New package
>
> ---
>  elpa-packages | 3 +++
>  1 file changed, 3 insertions(+)
>
> diff --git a/elpa-packages b/elpa-packages
> index 0ea8b159a6..3ddbfec540 100644
> --- a/elpa-packages
> +++ b/elpa-packages
> @@ -402,6 +402,9 @@
>    :release-branch "stable"
>    :doc "doc/hyperdrive.org")
>  
> + (hyperdrive-org-transclusion :url "https://git.sr.ht/~ushin/hyperdrive-org-transclusion"
> +  :news "CHANGELOG.org")
> +
>   (idle-highlight-mode	:url "https://codeberg.org/ideasman42/emacs-idle-highlight-mode"
>    :ignored-files (".elisp-autofmt"))

I'll go ahead an apply this change, as the local variable issue isn't
something I'd consider to be "blocking".

-- 
	Philip Kaludercic on siskin

Re: [NonGNU ELPA] New package: hyperdrive-org-transclusion

[Joseph Turner]

Philip Kaludercic <philipk@posteo.net> writes:

> Joseph Turner <joseph@ushin.org> writes:
>
>> Philip Kaludercic <philipk@posteo.net> writes:
>>
>>> Joseph Turner <joseph@ushin.org> writes:
>>>
>>>> Hello all,
>>>
>>> Hey, sorry for the delay,
>>>
>>>> <https://git.sr.ht/~ushin/hyperdrive-org-transclusion> extends
>>>> org-transclusion by allowing content served over the hyper:// network to
>>>> be transcluded using hyperdrive.el.  
>>>
>>> Code/content-wise, I cannot really comment on anything as it is based on
>>> multiple layers of API that I am not familiar with.  That being said,
>>> the (display-fill-column-indicator-mode) in the .dir-locals.el file is
>>> very unusual and something I think you should avoid.  Also, an
>>> .elpaignore file that would exclude some of the files that are only
>>> interesting to contributors and maintainers would be nice.
>>
>> Thank you for the review!!
>>
>> The (display-fill-column-indicator-mode) addition was something that we
>> settled on in the hyperdrive.el project last year as a way to remind
>> contributors to fill code before committing.  I'm open to removing it.
>> Would you elaborate on the reasons to avoid it?
>
> The main reasons is that it involves an `eval' expression, which is
> inherently controversial, especially when enabling a visual minor mode.
>
> Have you considered using Git hooks to enforce the style guide?

I hadn't, thanks!  I'd still like the option for some highly nested code
to go beyond the 80 column limit, and I'm concerned that the Git hook
approach would not give the programmer the discretion to break the rule.

>>>> + (hyperdrive-org-transclusion :url "https://git.sr.ht/~ushin/hyperdrive-org-transclusion"
>>>> +  :readme "README.org"
>>>
>>> This file is automatically detected, we just choose to ignore README.md
>>> files by default.
>>
>> Good to know.  I've removed that line in the attached patch.
>>
>>>> +  :news "CHANGELOG.org")
>>>
>>> Fun fact:  If you call the file NEWS.org, it will be automatically detected.
>>
>> Good to know.  I'd like to leave CHANGELOG.org as it is for now.
>
> This is actually a fairly common file name, that it would be worth
> checking for it as well.

Agreed.

>> Thank you!!
>>
>> Joseph
>>
>>
>> From 931e466053437a727fea76005b368f436cbf80e9 Mon Sep 17 00:00:00 2001
>> From: Joseph Turner <joseph@breatheoutbreathe.in>
>> Date: Sun, 22 Sep 2024 22:46:57 -0700
>> Subject: [PATCH] * elpa-packages (hyperdrive-org-transclusion): New package
>>
>> ---
>>  elpa-packages | 3 +++
>>  1 file changed, 3 insertions(+)
>>
>> diff --git a/elpa-packages b/elpa-packages
>> index 0ea8b159a6..3ddbfec540 100644
>> --- a/elpa-packages
>> +++ b/elpa-packages
>> @@ -402,6 +402,9 @@
>>    :release-branch "stable"
>>    :doc "doc/hyperdrive.org")
>>  
>> + (hyperdrive-org-transclusion :url "https://git.sr.ht/~ushin/hyperdrive-org-transclusion"
>> +  :news "CHANGELOG.org")
>> +
>>   (idle-highlight-mode	:url "https://codeberg.org/ideasman42/emacs-idle-highlight-mode"
>>    :ignored-files (".elisp-autofmt"))
>
> I'll go ahead an apply this change, as the local variable issue isn't
> something I'd consider to be "blocking".

Thank you!!

Joseph