vim-flavor 3.0.0 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c4a7e4092417600cbc0307de9313599a143deaca2418cd5ccb16e8959e678d04
4
- data.tar.gz: d6f6aa114fdd8f2202436e548694c8e382776ddae31bc3a3f6b2a07b27e880db
3
+ metadata.gz: 4b56f0299185327f581b7620d37b424150e44c4fbf9b644818f9a58430569116
4
+ data.tar.gz: a49bde472dcd149d79a41f4e260467cc8eb1da9865308536610667a00e50e598
5
5
  SHA512:
6
- metadata.gz: 638033e0aec514a1586f29e5a758159177fd7931c0709344b8f5ba8a49ce436d8ab15180e2698096c37545caf09f2050bdbfba9d098fec5a7299b4b59e93d2de
7
- data.tar.gz: 51a1d6dd6c932d9de194a2f9054bcaf2be0d5228c26e47715793fae8dbf5399acbd82722bae13677bdd44fffe35b2ba03d7b7b1089ca27097d62e8f54ba8b309
6
+ metadata.gz: a9babe8f14a01142a406f0e686c9a1b67ec7bae7418db50320af0ad55c348382b34e7b2a91dd9bfb5b7aa83486f403979a1cb45f3271a9b06365fe592d055605
7
+ data.tar.gz: 3a6f954a798748573d82de17b50b7fa0a6d11621f62231005a00699e3dd8fdb65d12d474a731153822b2b40e35d51e5398b39f1610555e21e3ea7cab4508c75a
@@ -0,0 +1,12 @@
1
+ # To get started with Dependabot version updates, you'll need to specify which
2
+ # package ecosystems to update and where the package manifests are located.
3
+ # Please see the documentation for all configuration options:
4
+ # https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5
+
6
+ version: 2
7
+ updates:
8
+ - package-ecosystem: "bundler" # See documentation for possible values
9
+ directory: "/" # Location of package manifests
10
+ schedule:
11
+ interval: "weekly"
12
+ versioning-strategy: increase
@@ -0,0 +1,35 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: [ master ]
6
+ pull_request:
7
+ branches: [ master ]
8
+ schedule:
9
+ - cron: 0 0 * * *
10
+
11
+ jobs:
12
+ test:
13
+ runs-on: ubuntu-latest
14
+ steps:
15
+ - uses: actions/checkout@v2
16
+ with:
17
+ fetch-depth: 0 # t/blame.vim requires all commits.
18
+ - name: Set up Ruby
19
+ uses: ruby/setup-ruby@v1
20
+ with:
21
+ bundler-cache: true # runs 'bundle install' and caches installed gems automatically
22
+ - name: Set up Vim
23
+ uses: thinca/action-setup-vim@v1
24
+ with:
25
+ vim_version: ${{ github.event_name == 'schedule' && 'head' || 'v8.2.3446' }}
26
+ vim_type: vim
27
+ download: never # For some reason 'available' doesn't build from source as a fallback.
28
+ - name: Set up Git
29
+ run: |
30
+ git config --global user.email 'ci@example.com'
31
+ git config --global user.name 'CI'
32
+ git config --global init.defaultBranch 'master'
33
+ git submodule update --init
34
+ - name: Run tests
35
+ run: rake ci
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ 3.0.2
data/README.md CHANGED
@@ -1,71 +1,157 @@
1
1
  # vim-flavor, a tool to manage your favorite Vim plugins
2
2
 
3
- [![Build Status](https://travis-ci.org/kana/vim-flavor.png)](https://travis-ci.org/kana/vim-flavor)
3
+ [![CI](https://github.com/kana/vim-flavor/actions/workflows/ci.yml/badge.svg)](https://github.com/kana/vim-flavor/actions/workflows/ci.yml)
4
4
  [![Maintainability](https://api.codeclimate.com/v1/badges/97414d95fb6d19c7fb72/maintainability)](https://codeclimate.com/github/kana/vim-flavor/maintainability)
5
5
 
6
6
 
7
7
 
8
8
 
9
- ## Getting started
9
+ # Getting started
10
10
 
11
- cd $YOUR_REPOSITORY_FOR_DOTFILES
11
+ ## Create `Flavorfile`
12
12
 
13
- cat >Flavorfile <<'END'
14
- # * Declare using git://github.com/kana/vim-textobj-indent.git
15
- # * vim-flavor fetches git://github.com/$USER/$REPO.git
16
- # if the argument is written in '$USER/$REPO' format.
17
- # * kana/vim-textobj-indent requires kana/vim-textobj-user.
18
- # Such dependencies are automatically installed
19
- # if the flavored plugin declares its dependencies with Flavorfile.
20
- flavor 'kana/vim-textobj-indent'
13
+ This file contains a set of declarations about what Vim plugins you want to
14
+ install. For example:
21
15
 
22
- # * Declare using git://github.com/vim-scripts/fakeclip.git
23
- # * vim-flavor fetches git://github.com/vim-scripts/$REPO.git
24
- # if the argument is written in '$REPO' format.
25
- flavor 'fakeclip'
16
+ ```ruby
17
+ # Install a Vim plugin from `https://github.com/kana/vim-textobj-indent`.
18
+ #
19
+ # Note that kana/vim-textobj-indent requires kana/vim-textobj-user.
20
+ # Such dependencies are automatically installed if the former plugin
21
+ # declares its dependencies with Flavorfile.
22
+ flavor 'kana/vim-textobj-indent'
26
23
 
27
- # * Declare using git://github.com/kana/vim-altr.git
28
- # * vim-flavor fetches the URI
29
- # if the argument seems to be a URI.
30
- flavor 'git://github.com/kana/vim-altr.git'
24
+ # Install a Vim plugin from `https://github.com/vim-scripts/fakeclip`.
25
+ flavor 'fakeclip'
31
26
 
32
- # * Declare using kana/vim-smartchr 0.1.0 or later and older than 0.2.0.
33
- flavor 'kana/vim-smartchr', '~> 0.1.0'
27
+ # Install a Vim plugin from the specified URI.
28
+ flavor 'git://github.com/kana/vim-altr.git'
34
29
 
35
- # * Declare using kana/vim-smartword 0.1 or later and older than 1.0.
36
- flavor 'kana/vim-smartword', '~> 0.1'
30
+ # You can also specify which version of Vim plugin should be installed.
31
+ # For example:
32
+ flavor 'kana/vim-smartword', '~> 0.1' # 0.1 or later, but older than 0.2
33
+ flavor 'kana/vim-smartchr', '~> 0.2.4' # 0.2.4 or later, but older than 0.3.0
34
+ flavor 'kana/vim-smarttill', '>= 0.3.6' # 0.3.6 or later
37
35
 
38
- # * Declare using kana/vim-smarttill 0.1.0 or later.
39
- flavor 'kana/vim-smarttill', '>= 0.1.0'
40
- END
36
+ # vim-flavor, by design, requires Vim plugins to follow semantic versioning
37
+ # and to create version tags (like `v1.2.3`) in their repositories.
38
+ #
39
+ # For repositories without versioning, branches can be specified.
40
+ flavor 'chriskempson/base16-vim', branch: 'master'
41
+ ```
41
42
 
42
- # Fetch the plugins declared in the Flavorfile,
43
- # create Flavorfile.lock for a snapshot of all plugins and versions,
44
- # then install the plugins into ~/.vim.
45
- vim-flavor install
43
+ ## Install Vim plugins (for the first time)
46
44
 
47
- git add Flavorfile Flavorfile.lock
48
- git commit -m 'Use vim-flavor to manage my favorite Vim plugins'
45
+ Run the following command:
49
46
 
50
- See also
51
- [the documentation on relish](https://www.relishapp.com/kana/vim-flavor) or
52
- `features/` directory for the details.
47
+ ```bash
48
+ vim-flavor install
49
+ ```
53
50
 
51
+ This command does the following stuffs:
54
52
 
53
+ 1. Fetches Vim plugins declared in the `Flavorfile`.
54
+ 2. Creates `Flavorfile.lock` file. It contains information about what
55
+ versions of plugins to be installed.
56
+ 3. Copies the fetched plugins into `~/.vim/pack/flavors/start`, then updates
57
+ help tags for each plugin.
55
58
 
59
+ It's recommended to commit `Flavorfile` and `Flavorfile.lock` after
60
+ installation.
56
61
 
57
- ## License
62
+ ```bash
63
+ git add Flavorfile Flavorfile.lock
64
+ git commit -m 'Use vim-flavor to manage my favorite Vim plugins'
65
+ ```
66
+
67
+ ## Install Vim plugins (from another machine)
68
+
69
+ Suppose that you work with several PCs and/or servers, and you want to use the
70
+ same configuration, including Vim plugins, on all of them.
71
+
72
+ Firstly, let's synchronize your configuration files:
73
+
74
+ ```bash
75
+ cd ~/your/dotfiles/repository
76
+ git pull
77
+ ```
78
+
79
+ Now you have the same `Flavorfile` and `Flavorfile.lock` created by the
80
+ previous step.
81
+
82
+ Then run the following command:
83
+
84
+ ```bash
85
+ vim-flavor install
86
+ ```
87
+
88
+ This time `vim-flavor` installs the same versions of Vim plugins as recorded
89
+ in `Flavorfile.lock`, even if newer versions are available.
90
+
91
+ ## Update Vim plugins
92
+
93
+ To update Vim plugins, run the following command:
94
+
95
+ ```bash
96
+ vim-flavor update
97
+ ```
98
+
99
+ This is similar to `vim-flavor install`, but vim-flavor tries checking and
100
+ installing newer versions of Vim plugins.
101
+
102
+ This command usually updates `Flavorfile.lock`. So that you have to commit it
103
+ again.
104
+
105
+ ```bash
106
+ git add Flavorfile.lock
107
+ git commit -m 'Update Vim plugins'
108
+ ```
109
+
110
+
111
+
112
+
113
+ # References
114
+
115
+ See [`features/`](./features) directory for the details.
116
+ The same [documents](https://www.relishapp.com/kana/vim-flavor) are available
117
+ also on relish.
118
+
119
+
120
+
121
+
122
+ # License
58
123
 
59
124
  vim-flavor is released under the terms of MIT license.
60
- See the LICENSE file for the details.
125
+ See the [LICENSE](./LICENSE) file for the details.
126
+
127
+
128
+
129
+
130
+ # Development
131
+
132
+ ## Set up
133
+
134
+ 1. Install [rbenv](https://github.com/rbenv/rbenv).
135
+ 2. Run the following commands in your clone of vim-flavor repository:
136
+
137
+ ```bash
138
+ git submodule update --init
139
+ rbenv install
140
+ bundle install
141
+ ```
142
+
143
+ ## Run tests
144
+
145
+ ```bash
146
+ rake test
147
+ ```
61
148
 
62
149
 
63
150
 
64
151
 
65
- ## Author
152
+ # Author
66
153
 
67
- * [Kana Natsuno](https://whileimautomaton.net/)
68
- (also known as [@kana1](https://twitter.com/kana1))
154
+ * [kana](https://github.com/kana)
69
155
 
70
156
 
71
157
 
data/Rakefile CHANGED
@@ -1,6 +1,12 @@
1
1
  #!/usr/bin/env rake
2
2
  require "bundler/gem_tasks"
3
3
 
4
+ task :ci => [:dump, :test]
5
+
6
+ task :dump do
7
+ sh 'vim --version'
8
+ end
9
+
4
10
  task :test => [:spec, :cucumber]
5
11
 
6
12
  task :spec do
@@ -10,3 +16,8 @@ end
10
16
  task :cucumber do
11
17
  sh 'bundle exec cucumber --format=progress'
12
18
  end
19
+
20
+ task :update_online_documents do
21
+ # Only authorized members can push to relish.
22
+ sh 'bundle exec relish push kana/vim-flavor'
23
+ end
@@ -0,0 +1 @@
1
+ default: --publish-quiet
@@ -1,8 +1,8 @@
1
1
  ## Required softwares
2
2
 
3
3
  * [Git](https://git-scm.com/) 2.10.1 or later
4
- * [Ruby](https://www.ruby-lang.org/) 2.5.0 or later
5
- * Recommendation: Use [RVM](https://rvm.io/) or other tools
4
+ * [Ruby](https://www.ruby-lang.org/) 3.0.0 or later
5
+ * Recommendation: Use [rbenv](https://github.com/rbenv/rbenv) or other tools
6
6
  for ease of installation across different envinronments.
7
7
  * [Vim](https://www.vim.org/) 8.0 or later
8
8
  * Note that Vim should be compiled as normal, big or huge version
data/features/news.md CHANGED
@@ -1,3 +1,12 @@
1
+ ## vim-flavor 4.0.0
2
+
3
+ ### Incompatible changes
4
+
5
+ * Ruby 3.0 or later is required now.
6
+
7
+
8
+
9
+
1
10
  ## vim-flavor 3.0.0
2
11
 
3
12
  ### Enhancements
@@ -36,7 +36,7 @@ Feature: Failures
36
36
  -------- Testing a Vim plugin
37
37
  t/basics.vim ..\s
38
38
  not ok 1 - g:foo is equal to 5
39
- # Expected g:foo == 5
39
+ # Expected g:foo == 5 at line 1
40
40
  # Actual value: 3
41
41
  # Expected value: 5
42
42
  Failed 1/1 subtests
@@ -1,7 +1,7 @@
1
1
  ## Uninstallation steps
2
2
 
3
3
  rm -rf ~/.vim-flavor
4
- rm -rf ~/.vim/flavors # or ~/vimfiles/flavors etc.
4
+ rm -rf ~/.vim/pack/flavors
5
5
 
6
6
  cd $YOUR_REPOSITORY_FOR_DOTFILES
7
7
  rm Flavorfile Flavorfile.lock
@@ -1,6 +1,6 @@
1
1
  module Vim
2
2
  module Flavor
3
- VERSION = '3.0.0'
3
+ VERSION = '4.0.0'
4
4
 
5
5
  class Version
6
6
  def self.create(arg)
data/vim-flavor.gemspec CHANGED
@@ -17,14 +17,14 @@ Gem::Specification.new do |spec|
17
17
  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
18
  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
19
  spec.require_paths = ['lib']
20
- spec.required_ruby_version = '~> 2.5'
20
+ spec.required_ruby_version = '~> 3.0'
21
21
 
22
- spec.add_dependency('parslet', '~> 1.8')
22
+ spec.add_dependency('parslet', '>= 1.8', '< 3.0')
23
23
  spec.add_dependency('pastel', '~> 0.7')
24
- spec.add_dependency('thor', '~> 0.20')
24
+ spec.add_dependency('thor', '>= 0.20', '< 2.0')
25
25
 
26
26
  spec.add_development_dependency('aruba', '~> 0.14')
27
- spec.add_development_dependency('cucumber', '~> 3.1')
27
+ spec.add_development_dependency('cucumber', '~> 7.0')
28
28
  spec.add_development_dependency('pry')
29
29
  spec.add_development_dependency('relish', '~> 0.7')
30
30
  spec.add_development_dependency('rspec', '~> 3.7')
metadata CHANGED
@@ -1,29 +1,35 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: vim-flavor
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.0
4
+ version: 4.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Kana Natsuno
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-03-24 00:00:00.000000000 Z
11
+ date: 2021-09-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: parslet
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - "~>"
17
+ - - ">="
18
18
  - !ruby/object:Gem::Version
19
19
  version: '1.8'
20
+ - - "<"
21
+ - !ruby/object:Gem::Version
22
+ version: '3.0'
20
23
  type: :runtime
21
24
  prerelease: false
22
25
  version_requirements: !ruby/object:Gem::Requirement
23
26
  requirements:
24
- - - "~>"
27
+ - - ">="
25
28
  - !ruby/object:Gem::Version
26
29
  version: '1.8'
30
+ - - "<"
31
+ - !ruby/object:Gem::Version
32
+ version: '3.0'
27
33
  - !ruby/object:Gem::Dependency
28
34
  name: pastel
29
35
  requirement: !ruby/object:Gem::Requirement
@@ -42,16 +48,22 @@ dependencies:
42
48
  name: thor
43
49
  requirement: !ruby/object:Gem::Requirement
44
50
  requirements:
45
- - - "~>"
51
+ - - ">="
46
52
  - !ruby/object:Gem::Version
47
53
  version: '0.20'
54
+ - - "<"
55
+ - !ruby/object:Gem::Version
56
+ version: '2.0'
48
57
  type: :runtime
49
58
  prerelease: false
50
59
  version_requirements: !ruby/object:Gem::Requirement
51
60
  requirements:
52
- - - "~>"
61
+ - - ">="
53
62
  - !ruby/object:Gem::Version
54
63
  version: '0.20'
64
+ - - "<"
65
+ - !ruby/object:Gem::Version
66
+ version: '2.0'
55
67
  - !ruby/object:Gem::Dependency
56
68
  name: aruba
57
69
  requirement: !ruby/object:Gem::Requirement
@@ -72,14 +84,14 @@ dependencies:
72
84
  requirements:
73
85
  - - "~>"
74
86
  - !ruby/object:Gem::Version
75
- version: '3.1'
87
+ version: '7.0'
76
88
  type: :development
77
89
  prerelease: false
78
90
  version_requirements: !ruby/object:Gem::Requirement
79
91
  requirements:
80
92
  - - "~>"
81
93
  - !ruby/object:Gem::Version
82
- version: '3.1'
94
+ version: '7.0'
83
95
  - !ruby/object:Gem::Dependency
84
96
  name: pry
85
97
  requirement: !ruby/object:Gem::Requirement
@@ -130,15 +142,18 @@ executables:
130
142
  extensions: []
131
143
  extra_rdoc_files: []
132
144
  files:
145
+ - ".github/dependabot.yml"
146
+ - ".github/workflows/ci.yml"
133
147
  - ".gitignore"
134
148
  - ".gitmodules"
135
149
  - ".rspec"
136
- - ".travis.yml"
150
+ - ".ruby-version"
137
151
  - Gemfile
138
152
  - LICENSE
139
153
  - README.md
140
154
  - Rakefile
141
155
  - bin/vim-flavor
156
+ - config/cucumber.yml
142
157
  - features/.nav
143
158
  - features/README.md
144
159
  - features/backward_compatibilities/flavorfile.feature
@@ -219,7 +234,7 @@ homepage: https://github.com/kana/vim-flavor
219
234
  licenses:
220
235
  - MIT
221
236
  metadata: {}
222
- post_install_message:
237
+ post_install_message:
223
238
  rdoc_options: []
224
239
  require_paths:
225
240
  - lib
@@ -227,16 +242,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
227
242
  requirements:
228
243
  - - "~>"
229
244
  - !ruby/object:Gem::Version
230
- version: '2.5'
245
+ version: '3.0'
231
246
  required_rubygems_version: !ruby/object:Gem::Requirement
232
247
  requirements:
233
248
  - - ">="
234
249
  - !ruby/object:Gem::Version
235
250
  version: '0'
236
251
  requirements: []
237
- rubyforge_project:
238
- rubygems_version: 2.7.3
239
- signing_key:
252
+ rubygems_version: 3.2.27
253
+ signing_key:
240
254
  specification_version: 4
241
255
  summary: A tool to manage your favorite Vim plugins
242
256
  test_files:
data/.travis.yml DELETED
@@ -1,7 +0,0 @@
1
- language: ruby
2
- rvm:
3
- - 2.5.0
4
- before_script:
5
- - git config --global 'user.name' 'Travis CI'
6
- - git config --global 'user.email' 'user@example.com'
7
- script: rake test