Merge pull request #5 from holochain-open-dev/chore/publish-package

rename package to 'hc_prefix_index'

CHANGELOG.md

@@ -2,11 +2,26 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.9.0] - 2023-12-16
+
+### Miscellaneous Tasks
+
+- Move package dir to match name
+
+### Refactor
+
+- Rename package 'hc_prefix_index'
+
+### Build
+
+- Bump package version
+
 ## [0.8.0] - 2023-12-16
 
 ### Documentation
 
 - Add changelog
+- Changelog
 
 ### Miscellaneous Tasks
 

Cargo.toml

@@ -23,5 +23,5 @@ path = "dnas/demo/zomes/coordinator/demo"
 [workspace.dependencies.demo_integrity]
 path = "dnas/demo/zomes/integrity/demo"
 
-[workspace.dependencies.prefix_index]
-path = "lib/prefix_index"
+[workspace.dependencies.hc_prefix_index]
+path = "lib/hc_prefix_index"

README.md

@@ -6,33 +6,35 @@ A prefix index is useful for typeahead "search" functionality.
 
 ## Usage
 
-1. Include the prefix_index crate in your coordinator zome's Cargo.toml:
+1. Include the hc_prefix_index crate in your coordinator zome's Cargo.toml:
 
 ```toml
 [dependencies]
 ...
-prefix_index = { git = "https://github.com/mattyg/holochain-prefix-index" module = "prefix_index" }
+hc_prefix_index = "=0.9.0"
 ```
 
-2. Include the prefix_index crate in your integrity zome's Cargo.toml and create a link type for the index:
+2. Include the hc_prefix_index crate in your integrity zome's Cargo.toml
+
+3. Create a link type for the index:
 ```rust
 #[hdk_link_types]
 enum LinkTypes {
     PrefixIndex
 }
 ```
 
-3. Add the prefix index validation functions to your validate match arm for CreateLink and DeleteLink on LinkTypes::PrefixIndex
+4. Add the prefix index validation functions to your validate match arm for CreateLink and DeleteLink on LinkTypes::PrefixIndex
 
-3. Setup a prefix index
+5. Setup a prefix index
 
 ```rust
 use prefix_index::PrefixIndex;
 
 let index = PrefixIndex::new("demo_index".into(), LinkTypes::PrefixIndex, 3, 3)?;
 ```
 
-4. Add some results to the index:
+6. Add some results to the index:
 ```rust
 index.add_result("superdupercool");
 index.add_result("superdupercrazy");
@@ -42,7 +44,7 @@ index.add_result("SUPERDUPER");
 
 ```
 
-5. This will generate an index of links for the strings as follows:
+7. This will generate an index of links for the strings as follows:
 
 ```mermaid
 flowchart LR
@@ -54,7 +56,7 @@ flowchart LR
     B --> J[ers] --> K[atu] --> L[supersaturates]
 ```
 
-6. Now you can search the index using DFS.
+8. Now you can search the index using DFS.
 ```rust
 index.get_results("sup", 10);
 // [

dnas/demo/zomes/coordinator/demo/Cargo.toml

@@ -11,7 +11,7 @@ name = "demo"
 hdk = { workspace = true }
 serde = { workspace = true }
 demo_integrity = { workspace = true }
-prefix_index = { workspace = true }
+hc_prefix_index = { workspace = true }
 
 [dev-dependencies]
 hdk = { workspace = true, features = ["encoding", "test_utils"] }

dnas/demo/zomes/coordinator/demo/src/demo_prefix_index.rs

@@ -1,6 +1,6 @@
 use demo_integrity::*;
+use hc_prefix_index::PrefixIndex;
 use hdk::prelude::*;
-use prefix_index::PrefixIndex;
 
 #[hdk_extern]
 pub fn add_to_index_a(text: String) -> ExternResult<()> {

dnas/demo/zomes/integrity/demo/Cargo.toml

@@ -9,6 +9,5 @@ name = "demo_integrity"
 
 [dependencies]
 hdi = { workspace = true }
-
 serde = { workspace = true }
-prefix_index = { workspace = true }
+hc_prefix_index = { workspace = true }

dnas/demo/zomes/integrity/demo/src/lib.rs

@@ -1,5 +1,5 @@
+use hc_prefix_index::PrefixIndex;
 use hdi::prelude::*;
-use prefix_index::PrefixIndex;
 
 pub const PREFIX_INDEX_A_NAME: &str = "prefix_index_a";
 pub const PREFIX_INDEX_A_WIDTH: usize = 3;

lib/prefix_index/Cargo.toml → lib/hc_prefix_index/Cargo.toml

@@ -1,11 +1,11 @@
 [package]
-name = "prefix_index"
-version = "0.8.0"
+name = "hc_prefix_index"
+version = "0.9.0"
 edition = "2021"
 
 [lib]
 crate-type = ["cdylib", "rlib"]
-name = "prefix_index"
+name = "hc_prefix_index"
 
 [dependencies]
 hdk = { workspace = true }

lib/prefix_index/src/validate.rs → lib/hc_prefix_index/src/validate.rs

@@ -1,4 +1,3 @@
-//use crate::PREFIX_INDEX_WIDTH;
 use crate::PrefixIndex;
 use hdk::hash_path::path::{root_hash, Component};
 use hdk::prelude::*;