1.0 release

[raxod502]

OBSOLETE: 1.0 release checklist

This is a tracking issue for issues that need to be closed for the 1.0 release of straight.el:

• Improve user experience around package building:
  • Fix slowness while reloading init-file (Reloading init-file is slow #35).
  • Fix duplicate warnings on changing recipe (Redundant warning on changing recipe #34).
  • Investigate whether packages are built more than once during
    init (Packages are built multiple times #27).
  • Add straight-rebuild and straight-rebuild-all commands (Add straight-rebuild command #10).
  • Dependencies are screwed up when installing after init.
  • Install even built-in packages (Install even built-in packages #38).
  • Record individual packages in bulk find(1) operation (Record individual packages in bulk find(1) operation #42).
  • Don't load package.el at runtime (Accidentally introduced runtime dependency on package.el #43).
  • Support registering a package without installing it (Support registering a package without installing it #44).
  • Make sure straight-freeze-versions installs registration-only packages before freezing.
  • Figure out why ESS wants to make autoloads (Figure out why ESS wants to make autoloads #61).
  • Automatically prune build directory (Add way to prune build directory #50).
  • Build texinfo manuals (Support texinfo #71).
  • Support other build commands (Support arbitrary build commands #72).
• Make version-control support more customizable.
  • Support upstream/fork workflow (Explicit support for forks #29).
  • Remove pbl (Eliminate pbl #25).
    • Fix superfluous symlinking (straight.el links repositories directly if they end with .el #63).
  • Support pluggable version-control backends.
  • Install versions specified in lockfile by default (Default to versions specified in lockfile #23).
    • Clone correct version of straight.el on initial setup (Clone correct revision of straight.el if available in lockfile #56).
    • Allow to specify a custom recipe for straight.el (Allow overriding recipe for straight.el #57).
  • Support deferred installation in straight-freeze-versions (straight-freeze-versions needs to play nice with deferred installation #24).
  • Add straight-override-package (Add straight-override-package #39).
  • Fix bugs introduced by new version-control support.
    • Fix issues with default-directory in popup system (default-directory can get messed up if you switch buffers in a recursive edit #53).
    • Improve UX around pushing (push-pull popups are confusing for straight-freeze-versions #54).
    • Show unmerged commits when considering pull or push (Show unmerged commits when considering pull/push #55).
    • Fetch if needed in straight-thaw-versions (straight-thaw-versions requires fetch #58).
    • Eliminate nil branch name error (Merge nil to branch #59).
    • Fix byte-compilation staleness (Stale version of straight.el loaded #60).
    • Remove option to set remote URLs (Remove option to set remote URLs #64).
    • Set pushRemote and/or pushDefault when validating remotes (Set pushRemote and/or pushDefault when validating remotes #65).
    • Move away from decapitation (Move away from decapitation #66).
• Support pluggable recipe repositories (Make recipe repositories customizable #30).
  • Support org-elpa (Support org-elpa #36).
  • Support elpa externals-list (Support elpa externals-list #18).
  • Figure out why profile-dotemacs doesn't show up in Emacsattic (EmacsAttic not supported? #52).
  • Save versions of recipe repositories in lockfile (Versions of MELPA, Emacsmirror need to be in versions lockfile #26).
  • Use heuristics from borg.el to compute EmacsMirror recipes (Use heuristics from borg.el to compute EmacsMirror recipes #40).
  • Prefix argument should make straight-get-recipe prompt for recipe source (Prefix argument should make straight-get-recipe prompt for recipe source #62).
• Improve performance (It's slower than package.el #9):
  • Add option to only rebuild packages when changed in Emacs (Add option to only rebuild packages when changed in Emacs #41).
• Improve use-package integration:
  • Make use-package-install-deferred-package work (upstream, see Fix bug in use-package-install-deferred-package jwiegley/use-package#479).
  • Integrate registration-only package usage with use-package (Integrate registration-only package usage with use-package #45).
• Miscellaneous tasks:
  • Don't expose the internal arguments of straight-use-package (Don't expose internal arguments on straight-use-package #46).
  • Add Travis to check byte-compilation (Add Travis #19).
    • Run checkdoc on Travis (Run checkdoc on Travis #75).
    • Check for long lines on Travis (Check for long lines on Travis #77).
  • Allow overriding a package's commit hash in your own lockfile (Allow overriding a package's commit hash in your own lockfile #67).
  • Neuter package.el (Neuter package.el #73).
• Add comprehensive documentation (Add manual #28, Write developer manual #51).
  • Add example configurations (Add example configurations #74).

[raxod502]

IMPLEMENTED: New recipe specification

• :name - name of package, as a string
• :local-repo - name of local repository, as a string; defaults to a
  value possibly provided by the VC backend, or the name of the
  package
• :type - VC backend, as a symbol; support for git is built-in
  • :host - symbol specifying interpretation of :repo, can be
    nil (for url), github, gitlab, or bitbucket; defaults to nil
  • :repo - url or shorthand
  • :branch - branch to use for primary development; defaults to
    master
  • :upstream - optional, specifies upstream repository; plist
    with keys :host, :repo, :branch, as under :type

[raxod502]

OBSOLETE: Proposal for eliminating build step

Note: I have decided against this proposal. It introduces many new problems without offering any advantage over the current scheme.

Modified and added recipe keys:

• :load-path - list of relative paths to be added to load path for
  package and to be used for autoload generation; defaults to root
  directory or lisp subdirectory if provided, or is generated based
  on :files specification
• :autoloads-file - filename for autoloads file, defaults to package
  name
• :files - list of files to be considered as part of the package;
  affects autoload generation and dependency resolution

The old workflow went something like the following:

• At straight.el load-time, use find(1) to check for updates to any
  packages in the build cache. If there are none, then checks for
  packages in the build cache can later be skipped, as an
  optimization.
• When a package is registered:
  • Check if its repository is available. If not, and the user
    confirms, clone it.
  • Add its build directory to the load path.
  • Check if the package has been modified since its last build; if
    so:
    • Recursively delete the build directory.
    • Symlink the files specified by :files into the build
      directory.
    • Compute the dependencies of the package based on the files
      in the build directory, and store these in the build cache.
    • Register all of the package's dependencies.
    • Generate the autoloads for the package based on the files in
      the build directory.
    • Byte-compile the package's files in the build directory.
  • Register all of the package's dependencies.
  • Activate the package's autoloads.

The new workflow will go something like the following:

• When a package is registered:
  • Check if its repository is available. If not, and the user
    confirms, clone it.
  • Add the repository to the load path, according to :load-path.
  • Compute the dependencies, according to :files, and store these
    in a cache.
  • Register all of the package's dependencies.
  • Determine the autoloads file, according to :autoloads-file. If
    it does not exist, generate it based on :files and
    :load-path.
  • Activate the package's autoloads.
• To update the dependencies for a package, run M-x straight-update-dependencies.
• ...

[raxod502]

Closing this in favor of https://github.com/raxod502/straight.el/milestone/1. It's too much work to keep up to date.