Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add srfi recipe #6725

Merged
merged 1 commit into from
Mar 16, 2020
Merged

Add srfi recipe #6725

merged 1 commit into from
Mar 16, 2020

Conversation

lassik
Copy link
Contributor

@lassik lassik commented Feb 27, 2020

Brief summary of what the package does

Provides quick access to Scheme Requests for Implementation (SRFI)
documents from within Emacs:

  • M-x srfi-list brings up a *SRFI* buffer listing all SRFIs.

  • M-x srfi does the same, but allows live-narrowing the list by
    typing numbers or words into the minibuffer.

  • The *SRFI* buffer provides one-key commands to visit the SRFI
    document, its discussion archive (mailing list archive), and it
    version control repository. These commands open the right web
    pages in your web browser using browse-url.

Direct link to the package repository

https://github.com/srfi-explorations/emacs-srfi

Your association with the package

Wrote it.

Relevant communications with the upstream package maintainer

None needed

Checklist

Please confirm with x:

  • The package is released under a GPL-Compatible Free Software License.
  • I've read CONTRIBUTING.org
  • I've used the latest version of package-lint to check for packaging issues, and addressed its feedback
  • My elisp byte-compiles cleanly
  • M-x checkdoc is happy with my docstrings
  • I've built and installed the package using the instructions in CONTRIBUTING.org
  • I have confirmed some of these without doing them

@riscy
Copy link
Member

riscy commented Mar 7, 2020

Quick first pass --

srfi-data.el

byte-compile-file (using Emacs 26.3):

  • No issues!

checkdoc (using version 0.6.1):

  • No issues!

(Skipping package-lint on this file)

srfi.el

byte-compile-file (using Emacs 26.3):

  • No issues!

checkdoc (using version 0.6.1):

  • No issues!

package-lint-current-buffer (using version 20200226.2001):

  • No issues!

Experimental static checks/suggestions:

  • srfi.el#L116: This define-key could overwrite a user's keybindings. Try: (defvar my-map (let ((km (make-sparse-keymap))) (define-key ...) km))
  • srfi.el#L117: This define-key could overwrite a user's keybindings. Try: (defvar my-map (let ((km (make-sparse-keymap))) (define-key ...) km))
  • srfi.el#L118: This define-key could overwrite a user's keybindings. Try: (defvar my-map (let ((km (make-sparse-keymap))) (define-key ...) km))
  • srfi.el#L119: This define-key could overwrite a user's keybindings. Try: (defvar my-map (let ((km (make-sparse-keymap))) (define-key ...) km))
  • srfi.el#L120: This define-key could overwrite a user's keybindings. Try: (defvar my-map (let ((km (make-sparse-keymap))) (define-key ...) km))
  • Prefer the default recipe, especially for small packages. I think you can get away with it in this case?

@riscy riscy added the awaiting-upstream Awaiting action from an upstream maintainer label Mar 7, 2020
@lassik
Copy link
Contributor Author

lassik commented Mar 7, 2020

This define-key could overwrite a user's keybindings.

Fixed. Thanks!

@lassik
Copy link
Contributor Author

lassik commented Mar 7, 2020

Prefer the default recipe, especially for small packages. I think you can get away with it in this case?

srfi-data-convert.el is only useful for package maintainers who need to run it in order to generate srfi-data.el based on the upstream data file srfi-data.scm. (srfi-data-convert.el translates Scheme syntax to Emacs Lisp syntax and throws away information that srfi.el does not need). That's why I specified the MELPA recipe to exclude srfi-data-convert.el

@riscy riscy removed the awaiting-upstream Awaiting action from an upstream maintainer label Mar 8, 2020
recipes/srfi Outdated Show resolved Hide resolved
@lassik lassik force-pushed the add-srfi branch 2 times, most recently from 6fe3aef to f79d608 Compare March 10, 2020 17:55
@riscy
Copy link
Member

riscy commented Mar 15, 2020

Good point re: :exclude @conao3. Another option would be to put that special file inside its own directory, which MELPA would automatically ignore, but that's not a blocker.

I think to be evenhanded in my insistence for license boilerplate, we should consider srfi-data.el to be code, and as such it should have some boilerplate or a SPDX identifier.

Beyond that I think this is good to go, so ping me when ready. :)

@lassik
Copy link
Contributor Author

lassik commented Mar 15, 2020

Good point re: :exclude @conao3. Another option would be to put that special file inside its own directory, which MELPA would automatically ignore, but that's not a blocker.

OK, I moved srfi-data-convert.el (and the trivial shell script wrappers assisting it) into an admin subdirectory so they are excluded by the default recipe. Force-pushed this PR to update the recipe.

I think to be evenhanded in my insistence for license boilerplate, we should consider srfi-data.el to be code, and as such it should have some boilerplate or a SPDX identifier.

OK, the generator now outputs Copyright and SPDX-License-Identifier lines into srfi-data.el.

Beyond that I think this is good to go, so ping me when ready. :)

Thanks a lot!

@lassik
Copy link
Contributor Author

lassik commented Mar 15, 2020

@riscy Oh, and here's the ping :)

@riscy
Copy link
Member

riscy commented Mar 16, 2020

Thanks!

@riscy riscy merged commit ff84471 into melpa:master Mar 16, 2020
@lassik lassik deleted the add-srfi branch March 16, 2020 07:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants