Git submodules as cheatsheet paths don't work any more #694
Description
A description of the problem
Carries on from the problem reported and fixed in #690
Mine might be more of an uncommon edge case, so I totally understand if you decide it's unsupported. 🙂
- I have all my shell config in a repo, with various external scripts and tools as git submodules in that repo.
- The community cheatsheets repo is one of those submodules. Having the submodule lets me easily use git to keep the community cheatsheets regularly up to date with any changes. With this latest
cheatchange, because the cheatsheet directory contains a.gitfile (not a directory) for the submodule, it's stoppingcheatfrom seeing those files. If delete the.gitfile, it works. - The content of the
.gitfile in the cheatsheets submodule directory is justgitdir: ../../../.git/modules/zsh/zshscripts/cheatsheets
cheat version info
4.3.1
cheat configuration info
If your bug pertains to how cheatsheets are loaded and/or displayed, please
paste here the following information:
- The output of
cheat -d
community: /Users/lucascosti/repos/mac-config/zsh/zshscripts/cheatsheets
- The contents of your
conf.ymlfile
Stored in my repo here: https://github.com/lucascosti/mac-config/blob/d5f62819eb7efcbd9f0dcf8826142686b63eb77e/zsh/zshscripts/miscdotfiles/cheat/conf.yml.
---
# The editor to use with 'cheat -e <sheet>'. Defaults to $EDITOR or $VISUAL.
editor: vim
# Should 'cheat' always colorize output?
colorize: true
# Which 'chroma' colorscheme should be applied to the output?
# Options are available here:
# https://github.com/alecthomas/chroma/tree/master/styles
style: native
# Which 'chroma' "formatter" should be applied?
# One of: "terminal", "terminal256", "terminal16m"
formatter: terminal16m
# The paths at which cheatsheets are available. Tags associated with a cheatpath
# are automatically attached to all cheatsheets residing on that path.
#
# Whenever cheatsheets share the same title (like 'tar'), the most local
# cheatsheets (those which come later in this file) take precedent over the
# less local sheets. This allows you to create your own "overides" for
# "upstream" cheatsheets.
#
# But what if you want to view the "upstream" cheatsheets instead of your own?
# Cheatsheets may be filtered via 'cheat -t <tag>' in combination with other
# commands. So, if you want to view the 'tar' cheatsheet that is tagged as
# 'community' rather than your own, you can use: cheat tar -t community
cheatpaths:
# Paths that come earlier are considered to be the most "global", and will
# thus be overridden by more local cheatsheets. That being the case, you
# should probably list community cheatsheets first.
#
# Note that the paths and tags listed below are just examples. You may freely
# change them to suit your needs.
- name: community
path: ~/repos/mac-config/zsh/zshscripts/cheatsheets/
tags: [ community ]
readonly: true